Skip to main content
PATCH
Update contact comment

Authorizations

Authorization
string
header
required

Bearer token authentication using your API key

Path Parameters

org_id
string
required

Org ID

contact_id
string
required

Contact ID

activity_id
string
required

Activity ID

Body

Schema for updating a contact comment

comment
string

The content of the comment (max 2048 characters)

Required string length: 1 - 2048
attachments
string[]

Array of file IDs to attach to the comment (replaces existing attachments)

Maximum array length: 20

Response

200 - application/json

Schema for a contact comment

id
string
required
contact_id
string
required
comment
string | null
required
attachments
object[]
required

Files attached to the comment

created_at
string<date-time> | null
required
updated_at
string<date-time> | null
required
actor
object

User who posted the comment

agent
object

Agent who posted the comment

assistant
object

Assistant who posted the comment

message_id
string

The private note this comment mirrors, when it was written in a conversation

chat
object

The chat behind the comment: the conversation a note was written in, or the run that answered a tag

metadata
object

Activity metadata payload. Discriminated by type, which mirrors the parent activity row type.