Skip to content

Function: deleteBoardProperty() ​

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

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

Removes the property from the board identified by the id. Ths user removing the property is required to have permissions to modify the board.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ boardId: string; propertyKey: string; }-
parameters.boardIdstringThe id of the board from which the property will be removed.
parameters.propertyKey?stringThe key of the property to remove.
options?RequestOptions-

Returns ​

Promise<void>