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 'http://jira.local:8080/jira/rest//rest/api/3/comment//properties/' \
--header 'Content-Type: application/json' \
--data-raw 'null'

Response Example

200 - Example 1

null

Request

Path Params

commentId

string

required

The ID of the comment.

propertyKey

string

required

The key of the property. The maximum length is 255 characters.

Body Params application/json

No schema defined

Examples

Responses

🟢200Returned if the comment property is updated.

application/json

Body

No schema defined

🟢201Returned if the comment property is created.

🟠400Returned if the request is invalid.

🟠401Returned if the authentication credentials are incorrect or missing.

🟠403Returned if the user does not have the necessary permission.

🟠404Returned if the comment is not found.

Modified at 2023-07-13 03:27:27

Get comment property

Delete comment property