Update a comment

Update the content of an existing comment (author only)

PUT /v1/comments/{commentId}

Try it

Update a comment

cURL

curl --request PUT \
  --url http://localhost:3333/v1/comments/{commentId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "content": "This task needs to be completed by end of week (updated)"
}
'

200

{
  "id": "cmt_abc123def456",
  "content": "This task needs to be completed by end of week",
  "author": {
    "id": "usr_abc123def456",
    "name": "John Doe",
    "email": "[e-mail]",
    "image": "https://example.com/avatar.jpg",
    "deactivated": false
  },
  "attachments": [
    {
      "id": "att_abc123def456",
      "name": "document.pdf",
      "type": "application/pdf",
      "createdAt": "2024-01-15T10:30:00Z"
    }
  ],
  "createdAt": "2024-01-15T10:30:00Z"
}

Authorizations

X-API-Key · string · header · required

API key for authentication

Headers

X-Organization-Id · string

Organization ID (required for session auth, optional for API key auth)

Path Parameters

commentId · string · required

Unique comment identifier

Example:

"cmt_abc123def456"

Body

application/json

content · string · required

Updated content of the comment

Maximum string length: 2000

Example:

"This task needs to be completed by end of week (updated)"

Response

200 - application/json

Comment updated successfully

id · string · required

Unique identifier for the comment

Example:

"cmt_abc123def456"

content · string · required

Comment content

Example:

"This task needs to be completed by end of week"

author · object · required

Comment author information

Show child attributes

author. id · string · required

User ID

Example:

"usr_abc123def456"

author. name · string · required

User name

Example:

"John Doe"

author. email · string · required

User email

Example:

"[e-mail]"

author. image · object · required

User profile image URL

Example:

"https://example.com/avatar.jpg"

author. deactivated · boolean | null · required

Whether the user is deactivated

Example:

false

attachments · object[] · required

Attachment metadata (URLs generated on-demand)

Show child attributes

attachments. id · string · required

Unique identifier for the attachment

Example:

"att_abc123def456"

attachments. name · string · required

Original filename

Example:

"document.pdf"

attachments. type · string · required

File type/MIME type

Example:

"application/pdf"

attachments. createdAt · string<date-time> · required

Upload timestamp

Example:

"2024-01-15T10:30:00Z"

createdAt · string<date-time> · required

Comment creation timestamp

Example:

"2024-01-15T10:30:00Z"