TEteamhood
Comments

Add Comment to an item

Changed on

The comment is posted on behalf of the API, not of a user. A retry with the same requestId returns the comment the first request added.

post/api/v1/comments

Request

Request body

requestIdstring uuid nullable

Idempotency key

itemIdstring uuid required
contentstring nullable required

Plain text. Mention a workspace user to notify them as {{First Last|userId}} (2–8 space-separated words of letters, digits, _ or -) or {{email|userId}}; anything else is kept as plain text.

parentCommentIdstring uuid nullable

Set to reply to a top-level comment on the same item.

Example request

{
  "content": "Thanks {{Jane Doe|d290f1ee-6c54-4b01-90e6-d701748f0851}}, looks good."
}

Response

OK

idstring uuid required
itemIdstring uuid required
parentCommentIdstring uuid nullable

The top-level comment this comment replies to, or null for a top-level comment.

userIdstring uuid nullable
userNamestring nullable required
contentstring nullable required

Plain text. A mentioned user is encoded as {{Full Name|userId}} or {{email|userId}}.

createdOnstring date-time required
editedOnstring date-time nullable
isPinnedboolean required
isResolvedboolean required
attachmentIdsstring[] nullable required

Attachments linked to the comment; download them with GET /api/v1/attachments/{id}/content.

Example response

{
  "content": "Thanks {{Jane Doe|d290f1ee-6c54-4b01-90e6-d701748f0851}}, looks good."
}

Changes