Set comment property

PUT

/rest/api/3/comment/{commentId}/properties/{propertyKey}

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.

Also, when the visibility of a comment is restricted to a role or group the user must be a member of that role or group.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT '/rest/api/3/comment//properties/' \
--header 'Content-Type: application/json' \
--data-raw 'null'

Response Example

200 - Example 1

null

Request

Path Params

Body Params application/json

Examples

🟢200OK

application/json

Returned if the comment property is updated.

Body

🟢201Created

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Modified at 2025-07-16 07:18:01