Skip to content

Function: setProjectProperty() ​

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

Defined in: src/server/api/projects.ts:428

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

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ body: Record<string, any>; projectIdOrKey: string; propertyKey: string; }-
parameters.bodyRecord<string, any>-
parameters.projectIdOrKey?stringThe project on which the property will be set.
parameters.propertyKey?stringThe key of the project's property. The maximum length of the key is 255 bytes.
options?RequestOptions-

Returns ​

Promise<void>