Skip to content

Function: setProjectProperty() ​

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

Defined in: src/cloud/api/projectProperties.ts:72

Sets the value of the project property. You can use project properties to store custom data against the project.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

This operation can be accessed anonymously.

Permissions required:Administer Jira global permission or Administer Projects project permission for the project in which the property is created.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ body: Record<string, any>; projectIdOrKey: string; propertyKey: string; }-
parameters.bodyRecord<string, any>-
parameters.projectIdOrKey?stringThe project ID or project key (case sensitive).
parameters.propertyKey?stringThe key of the project property. The maximum length is 255 characters.
options?RequestOptions-

Returns ​

Promise<void>