Function: setSprintProperty()

function setSprintProperty(
   client, 
   parameters, 
   options?
): Promise<void>;

Defined in: src/server/api/sprint.ts:288

Sets the value of the specified sprint's property. You can use this resource to store a custom data against the sprint identified by the id. The user who stores the data is required to have permissions to modify the sprint.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ body: Record<string, any>; propertyKey: string; sprintId: number; }	-
parameters.body	Record<string, any>	-
parameters.propertyKey?	string	The key of the sprint's property. The maximum length of the key is 255 bytes.
parameters.sprintId?	number	The id of the sprint on which the property will be set.
options?	RequestOptions	-

Returns

Promise<void>