Skip to content

Add Channel Comment

POST
/inbox/channels/{channel_id}/comments

Leave an INTERNAL note. Not a reply - the customer never sees it.

MENTIONING SOMEONE CREATES THEM A TASK in the Work app. The two mention lists are additive rather than alternatives: an id with no matching email still gets the task, it just gets no notification, so send both to get the bell as well.

Attachments must already be uploaded; only their token and key are load-bearing, because the server re-validates and never trusts a client-sent name, size or type.

Authorizations

Parameters

Path Parameters

channel_id
required

Conversation id.

string

Conversation id.

Query Parameters

channel_type
required

Which channel the conversation lives in. REQUIRED: the same id means different rows in different channels, so this is what identifies the conversation, not a filter.

string
Allowed values: email chat phone sms heyreach meetings support all

Which channel the conversation lives in. REQUIRED: the same id means different rows in different channels, so this is what identifies the conversation, not a filter.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

An INTERNAL note on a conversation. The customer never sees it.

Mentioning someone creates them a task in the Work app. The two mention lists are ADDITIVE rather than alternatives: an id with no matching email still gets the task, it just gets no notification - so sending both is how you get the bell as well.

object
attachments
Array<object>

A file already uploaded to the private note namespace.

Only token and key are load-bearing: the server re-validates the capability token and never trusts the name, size or type a client sends. They are accepted because the app’s model accepts them.

object
key
required
string
<= 1024 characters
name
Any of:
string
size
Any of:
integer
token
required
string
<= 8192 characters
type
Any of:
string
content
required
string
>= 1 characters <= 5000 characters
mentioned_user_emails

The same users by email. Additive - this is what drives the notification.

Array<string>
mentioned_user_ids

Mentioned users by id. Each gets a Work task.

Array<string>

Responses

201

Successful Response

object
data
required

An open envelope for a comment, an assignment or a workspace.

Open because a comment carries attachment refs and mention metadata that grow, and because an assignment result reports per-assignee outcomes.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string