Function: setBoardProperty()

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

Defined in: src/agile/api/board.ts:577

Sets the value of the specified board's property.

You can use this resource to store a custom data against the board identified by the id. The user who stores the data is required to have permissions to modify the board.

Parameters

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

Returns

Promise<void>