Function: setBoardProperty()

function setBoardProperty(
   client, 
   parameters, 
   options?
): Promise<
  | {
[key: string]: unknown;
  keys?: object[];
}
| undefined>;

Defined in: src/server/api/board.ts:338

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: number; body: Record<string, any>; propertyKey: string; }	-
parameters.boardId	number	The id of the board on which the property will be set.
parameters.body?	Record<string, any>	-
parameters.propertyKey?	string	The key of the board's property.
options?	RequestOptions	-

Returns

Promise< | { [key: string]: unknown; keys?: object[]; } | undefined>