Skip to content

Set Channel Ai Pause

POST
/inbox/channels/{channel_id}/ai-pause

Stop the AI answering THIS conversation, or let it resume.

Scoped to the one thread: pausing here does not disable the responder anywhere else. This is the handover switch - pause it when a human takes over, so the customer does not get two replies.

paused is explicit rather than a toggle, so a retried request is idempotent instead of flipping the state back.

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

Stop or resume the AI auto-responder on ONE conversation.

Scoped to the conversation, not the org: pausing here does not disable the responder anywhere else.

object
paused
required

True stops the AI answering this thread; false lets it resume.

boolean

Responses

200

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