Function: setCommentProperty()
ts
function setCommentProperty(
client,
parameters,
options?
): Promise<void>;Defined in: src/cloud/api/issueCommentProperties.ts:76
Creates or updates the value of a property for a comment. Use this resource to store custom data against a comment.
The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.
Permissions required: either of:
- Edit All Comments project permission to create or update the value of a property on any comment.
- Edit Own Comments project permission to create or update the value of a property on a comment created by the user.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { body: Record<string, any>; commentId: string; propertyKey: string; } | - |
parameters.body | Record<string, any> | - |
parameters.commentId? | string | The ID of the comment. |
parameters.propertyKey? | string | The key of the property. The maximum length is 255 characters. |
options? | RequestOptions | - |
Returns
Promise<void>