Skip to content

Edit a comment

PATCH
/v1/comments/{id}
curl --request PATCH \
--url http://localhost:3000/v1/comments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "text": "example" }'

The caller must be the comment’s author. Anyone else, including a server token, is 403. The new text is scanned the same way as a create. A bounce leaves the stored text unchanged.

id
required
string format: uuid
Media typeapplication/json
object
text
required
string
>= 1 characters <= 2000 characters
Examplegenerated
{
"text": "example"
}

The comment.

Media typeapplication/json
object
id
required
string format: uuid
activity_id
required
string format: uuid
parent_id
required
string | null format: uuid
user_id
required
string
text
required
string
reply_count
required
integer
created_at
required
string format: date-time
edited_at
required
string | null format: date-time
Examplegenerated
{
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"activity_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"parent_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"user_id": "example",
"text": "example",
"reply_count": 1,
"created_at": "2026-04-15T12:00:00Z",
"edited_at": "2026-04-15T12:00:00Z"
}

VALIDATION_FAILED for bad length. CONTENT_REJECTED when the scan bounces. The message is This text isn't allowed. A bounce leaves the stored text unchanged.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: VALIDATION_FAILED UNAUTHENTICATED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED INTERNAL CONTENT_REJECTED
message
required
string
requestId
required
string
fields

Present only for VALIDATION_FAILED.

Array<object>
object
path
string
message
string
Example
{
"error": {
"code": "VALIDATION_FAILED"
}
}

Invalid, expired, revoked, or absent token.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: VALIDATION_FAILED UNAUTHENTICATED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED INTERNAL CONTENT_REJECTED
message
required
string
requestId
required
string
fields

Present only for VALIDATION_FAILED.

Array<object>
object
path
string
message
string
Example
{
"error": {
"code": "VALIDATION_FAILED"
}
}

Authenticated but not permitted.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: VALIDATION_FAILED UNAUTHENTICATED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED INTERNAL CONTENT_REJECTED
message
required
string
requestId
required
string
fields

Present only for VALIDATION_FAILED.

Array<object>
object
path
string
message
string
Example
{
"error": {
"code": "VALIDATION_FAILED"
}
}

Comment not found.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: VALIDATION_FAILED UNAUTHENTICATED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED INTERNAL CONTENT_REJECTED
message
required
string
requestId
required
string
fields

Present only for VALIDATION_FAILED.

Array<object>
object
path
string
message
string
Example
{
"error": {
"code": "VALIDATION_FAILED"
}
}