Conversations API · ShipMsg docs

List customer-controlled bot applications

GET /v1/accounts/{AC}/bot-applications

getV1AccountsByAcBotApplicationsPaginated200

Required scope: `inboxes:read`.

Parameters

Parameters
Name	Type	Required	Description
`limit`	query · integer (1–100)
`cursor`	query · string (max 2048 chars)
`AC`	path · string (AC… SID)	yes	Account SID

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Create a customer-controlled bot application

POST /v1/accounts/{AC}/bot-applications

postV1AccountsByAcBotApplicationsIdempotency-Key required201

Required scope: `inboxes:write`.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes	Account SID

Request body (5 fields)

Request body
Name	Type	Required
`fallbackInboxSid`	string (IB… SID)	yes
`name`	string (max 128 chars)	yes
`principalRef`	string (max 128 chars)	yes
`timeoutSeconds`	integer (5–3600)
`webhookEndpointSid`	string (WH… SID)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Update a customer-controlled bot application

PATCH /v1/accounts/{AC}/bot-applications/{BA}

patchV1AccountsByAcBotApplicationsByBaIdempotency-Key required200

Required scope: `inboxes:write`.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes	Account SID
`BA`	path · string (BA… SID)	yes

Request body (5 fields)

Request body
Name	Type	Required	Description
`fallbackInboxSid`	string (IB… SID)
`name`	string (max 128 chars)
`principalRef`	string (max 128 chars)
`timeoutSeconds`	integer (5–3600)
`webhookEndpointSid`	string (WH… SID)

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Disable a bot application when it has no active handoff

DELETE /v1/accounts/{AC}/bot-applications/{BA}

deleteV1AccountsByAcBotApplicationsByBa200

Required scope: `inboxes:write`.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes	Account SID
`BA`	path · string (BA… SID)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

List authorized conversations and collaboration state

GET /v1/accounts/{AC}/conversations

getV1AccountsByAcConversationsPaginated200

List conversations you may see, with their state, assignee and service-window expiry. Account-scoped credential: Required scope: `conversations:read`. Alternatively, a normal tenant USER session may use `conversations:read` through actual readable inbox membership in this workspace. Collection results include only accessible inboxes or their conversations; this grants no account-wide scopes, API-key permission, staff-delegation authority or platform access.

Parameters

Parameters
Name	Type	Required	Description
`inboxSid`	query · string (IB… SID)
`senderSid`	query · string (WA… SID)
`contactSid`	query · string (CT… SID)
`state`	query · "OPEN" \| "IDLE" \| "CLOSED" \| "ARCHIVED"
`assignee`	query · string (max 128 chars)
`unassigned`	query · boolean
`unread`	query · boolean
`priority`	query · "LOW" \| "NORMAL" \| "HIGH" \| "URGENT"
`tag`	query · string (pattern ^[a-z0-9][a-z0-9_-]{0,39}$)
`campaignSid`	query · string (CP… SID)
`consentState`	query · "OPTED_IN" \| "OPTED_OUT" \| "UNKNOWN" \| "REVOKED" \| "EXPIRED"
`riskFlag`	query · boolean
`slaState`	query · "healthy" \| "at_risk" \| "breached"
`snoozed`	query · boolean
`waiting`	query · boolean		Only open conversations where the customer's last message has not been answered.
`sort`	query · "recent" \| "longest_waiting"		`recent` (default): newest activity first. `longest_waiting`: the customer who has waited longest for a reply first; conversations nobody is waiting on come last.
`createdAfter`	query · string (date-time)
`createdBefore`	query · string (date-time)
`limit`	query · integer (1–100)
`cursor`	query · string (max 2048 chars)
`AC`	path · string (AC… SID)	yes	Account SID

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Search authorized conversations by identifier, contact and metadata

GET /v1/accounts/{AC}/conversations/search

getV1AccountsByAcConversationsSearchPaginated200

`q` matches the conversation sid, the contact sid and the contact display name. Message bodies are sealed at rest and are not searchable. Required scope: `conversations:read`.

Parameters

Parameters
Name	Type	Required	Description
`q`	query · string (max 200 chars)	yes
`inboxSid`	query · string (IB… SID)
`senderSid`	query · string (WA… SID)
`contactSid`	query · string (CT… SID)
`tag`	query · string (max 40 chars)
`assignee`	query · string (max 128 chars)
`from`	query · string (date-time)
`to`	query · string (date-time)
`limit`	query · integer (1–100)
`cursor`	query · string (max 2048 chars)
`AC`	path · string (AC… SID)	yes	Account SID

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Get a conversation

GET /v1/accounts/{AC}/conversations/{CO}

getV1AccountsByAcConversationsByCo200

Fetch one conversation with its assignment, tags and version. Account-scoped credential: Required scope: `conversations:read`. Alternatively, a normal tenant USER session may use `conversations:read` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes	Account SID
`CO`	path · string (CO… SID)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Assign a conversation

POST /v1/accounts/{AC}/conversations/{CO}/assign

postV1AccountsByAcConversationsByCoAssignIdempotency-Key required200

Assign a conversation to an available teammate in its inbox, by their principal reference. Send the `conversationVersion` you last read; a stale version is refused so two people cannot overwrite each other. Account-scoped credential: Required scope: `conversations:assign`. Alternatively, a normal tenant USER session may use `conversations:assign` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes	Account SID
`CO`	path · string (CO… SID)	yes

Request body (3 fields)

Request body
Name	Type	Required
`assigneePrincipalRef`	string (max 128 chars)	yes
`conversationVersion`	integer (1–)	yes
`reason`	string (max 1000 chars)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

List audited assignment and handoff history

GET /v1/accounts/{AC}/conversations/{CO}/assignments

getV1AccountsByAcConversationsByCoAssignmentsPaginated200

Account-scoped credential: Required scope: `conversations:read`. Alternatively, a normal tenant USER session may use `conversations:read` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access.

Parameters

Parameters
Name	Type	Required	Description
`limit`	query · integer (1–100)
`cursor`	query · string (max 2048 chars)
`AC`	path · string (AC… SID)	yes	Account SID
`CO`	path · string (CO… SID)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Acknowledge, activate, complete, or reject a bot handoff

POST /v1/accounts/{AC}/conversations/{CO}/bot-handoffs/{BH}/respond

postV1AccountsByAcConversationsByCoBotHandoffsByBhRespondIdempotency-Key required200

Required scope: `conversations:write`.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes	Account SID
`CO`	path · string (CO… SID)	yes
`BH`	path · string (BH… SID)	yes

Request body (2 fields)

Request body
Name	Type	Required	Description
`outcome`	"ACCEPT" \| "ACTIVE" \| "COMPLETE" \| "FAIL"	yes
`reason`	string (max 1000 chars)

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Retry a failed or timed-out bot handoff

POST /v1/accounts/{AC}/conversations/{CO}/bot-handoffs/{BH}/retry

postV1AccountsByAcConversationsByCoBotHandoffsByBhRetryIdempotency-Key required200

Account-scoped credential: Required scope: `conversations:write`. Alternatively, a normal tenant USER session may use `conversations:assign` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes	Account SID
`CO`	path · string (CO… SID)	yes
`BH`	path · string (BH… SID)	yes

Request body (1 fields)

Request body
Name	Type	Required	Description
`reason`	string (max 1000 chars)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Take an active bot handoff back to its human fallback inbox

POST /v1/accounts/{AC}/conversations/{CO}/bot-handoffs/{BH}/takeover

postV1AccountsByAcConversationsByCoBotHandoffsByBhTakeoverIdempotency-Key required200

Account-scoped credential: Required scope: `conversations:write`. Alternatively, a normal tenant USER session may use `conversations:assign` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes	Account SID
`CO`	path · string (CO… SID)	yes
`BH`	path · string (BH… SID)	yes

Request body (1 fields)

Request body
Name	Type	Required	Description
`reason`	string (max 1000 chars)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Acquire the exclusive composer claim

POST /v1/accounts/{AC}/conversations/{CO}/claim

postV1AccountsByAcConversationsByCoClaimIdempotency-Key required201

Account-scoped credential: Required scope: `conversations:write`. Alternatively, a normal tenant USER session may use `conversations:write` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes	Account SID
`CO`	path · string (CO… SID)	yes

Request body (3 fields)

Request body
Name	Type	Required
`conversationVersion`	integer (1–)	yes
`leaseSeconds`	integer (15–300)
`overrideReason`	string (max 1000 chars)

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Release the composer claim

POST /v1/accounts/{AC}/conversations/{CO}/claim/release

postV1AccountsByAcConversationsByCoClaimReleaseIdempotency-Key required200

Account-scoped credential: Required scope: `conversations:assign`. Alternatively, a normal tenant USER session may use `conversations:write` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes	Account SID
`CO`	path · string (CO… SID)	yes

Request body (2 fields)

Request body
Name	Type	Required	Description
`leaseSeconds`	integer (15–300)
`leaseToken`	string (uuid)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Renew the composer claim

POST /v1/accounts/{AC}/conversations/{CO}/claim/renew

postV1AccountsByAcConversationsByCoClaimRenewIdempotency-Key required200

Account-scoped credential: Required scope: `conversations:write`. Alternatively, a normal tenant USER session may use `conversations:write` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes	Account SID
`CO`	path · string (CO… SID)	yes

Request body (2 fields)

Request body
Name	Type	Required	Description
`leaseSeconds`	integer (15–300)
`leaseToken`	string (uuid)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Close a conversation

POST /v1/accounts/{AC}/conversations/{CO}/close

postV1AccountsByAcConversationsByCoCloseIdempotency-Key required200

Close a conversation. Send the `conversationVersion` you last read. Account-scoped credential: Required scope: `conversations:write`. Alternatively, a normal tenant USER session may use `conversations:write` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes	Account SID
`CO`	path · string (CO… SID)	yes

Request body (2 fields)

Request body
Name	Type	Required	Description
`conversationVersion`	integer (1–)	yes
`reason`	string (max 1000 chars)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

List conversation collaborators and followers

GET /v1/accounts/{AC}/conversations/{CO}/collaborators

getV1AccountsByAcConversationsByCoCollaborators200

Account-scoped credential: Required scope: `conversations:read`. Alternatively, a normal tenant USER session may use `conversations:read` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes	Account SID
`CO`	path · string (CO… SID)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Add a conversation collaborator

PUT /v1/accounts/{AC}/conversations/{CO}/collaborators/{principalRef}

putV1AccountsByAcConversationsByCoCollaboratorsByPrincipalrefIdempotency-Key required200

Account-scoped credential: Required scope: `conversations:write`. Alternatively, a normal tenant USER session may use `conversations:write` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes	Account SID
`CO`	path · string (CO… SID)	yes
`principalRef`	path · string (max 128 chars)	yes

Request body (1 fields)

Request body
Name	Type	Required	Description
`role`	"COLLABORATOR" \| "FOLLOWER"	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Remove a conversation collaborator

DELETE /v1/accounts/{AC}/conversations/{CO}/collaborators/{principalRef}

deleteV1AccountsByAcConversationsByCoCollaboratorsByPrincipalref200

Account-scoped credential: Required scope: `conversations:write`. Alternatively, a normal tenant USER session may use `conversations:write` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes	Account SID
`CO`	path · string (CO… SID)	yes
`principalRef`	path · string (max 128 chars)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

List retained message history for an authorized conversation

GET /v1/accounts/{AC}/conversations/{CO}/messages

getV1AccountsByAcConversationsByCoMessagesPaginated200

List the messages of a conversation, oldest first. Account-scoped credential: Required scope: `conversations:read`. Alternatively, a normal tenant USER session may use `conversations:read` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access.

Parameters

Parameters
Name	Type	Required	Description
`limit`	query · integer (1–100)
`cursor`	query · string (max 2048 chars)
`AC`	path · string (AC… SID)	yes	Account SID
`CO`	path · string (CO… SID)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

List encrypted internal notes

GET /v1/accounts/{AC}/conversations/{CO}/notes

getV1AccountsByAcConversationsByCoNotesPaginated200

Account-scoped credential: Required scope: `conversations:read`. Alternatively, a normal tenant USER session may use `conversations:read` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access.

Parameters

Parameters
Name	Type	Required	Description
`limit`	query · integer (1–100)
`cursor`	query · string (max 2048 chars)
`AC`	path · string (AC… SID)	yes	Account SID
`CO`	path · string (CO… SID)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Create an encrypted internal note

POST /v1/accounts/{AC}/conversations/{CO}/notes

postV1AccountsByAcConversationsByCoNotesIdempotency-Key required201

Account-scoped credential: Required scope: `conversations:note`. Alternatively, a normal tenant USER session may use `conversations:note` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes	Account SID
`CO`	path · string (CO… SID)	yes

Request body (2 fields)

Request body
Name	Type	Required	Description
`body`	string (max 20000 chars)	yes
`mentionedPrincipalRefs`	string (max 128 chars)[]

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Edit an internal note

PATCH /v1/accounts/{AC}/conversations/{CO}/notes/{NT}

patchV1AccountsByAcConversationsByCoNotesByNtIdempotency-Key required200

Account-scoped credential: Required scope: `conversations:note`. Alternatively, a normal tenant USER session may use `conversations:note` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes	Account SID
`CO`	path · string (CO… SID)	yes
`NT`	path · string (NT… SID)	yes

Request body (2 fields)

Request body
Name	Type	Required	Description
`body`	string (max 20000 chars)	yes
`mentionedPrincipalRefs`	string (max 128 chars)[]

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Delete an internal note

DELETE /v1/accounts/{AC}/conversations/{CO}/notes/{NT}

deleteV1AccountsByAcConversationsByCoNotesByNt200

Account-scoped credential: Required scope: `conversations:note`. Alternatively, a normal tenant USER session may use `conversations:note` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes	Account SID
`CO`	path · string (CO… SID)	yes
`NT`	path · string (NT… SID)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Change conversation priority and recalculate its SLA clocks

POST /v1/accounts/{AC}/conversations/{CO}/priority

postV1AccountsByAcConversationsByCoPriorityIdempotency-Key required200

Account-scoped credential: Required scope: `conversations:write`. Alternatively, a normal tenant USER session may use `conversations:write` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes	Account SID
`CO`	path · string (CO… SID)	yes

Request body (3 fields)

Request body
Name	Type	Required
`conversationVersion`	integer (1–)	yes
`priority`	"LOW" \| "NORMAL" \| "HIGH" \| "URGENT"	yes
`reason`	string (max 1000 chars)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Advance this principal's read cursor

POST /v1/accounts/{AC}/conversations/{CO}/read

postV1AccountsByAcConversationsByCoReadIdempotency-Key required200

Account-scoped credential: Required scope: `conversations:write`. Alternatively, a normal tenant USER session may use `conversations:write` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes	Account SID
`CO`	path · string (CO… SID)	yes

Request body (1 fields)

Request body
Name	Type	Required	Description
`lastReadMessageSid`	string (SM… SID)

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Release a conversation assignment

POST /v1/accounts/{AC}/conversations/{CO}/release

postV1AccountsByAcConversationsByCoReleaseIdempotency-Key required200

Account-scoped credential: Required scope: `conversations:assign`. Alternatively, a normal tenant USER session may use `conversations:assign` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes	Account SID
`CO`	path · string (CO… SID)	yes

Request body (2 fields)

Request body
Name	Type	Required	Description
`conversationVersion`	integer (1–)	yes
`reason`	string (max 1000 chars)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Reopen a conversation

POST /v1/accounts/{AC}/conversations/{CO}/reopen

postV1AccountsByAcConversationsByCoReopenIdempotency-Key required200

Account-scoped credential: Required scope: `conversations:write`. Alternatively, a normal tenant USER session may use `conversations:write` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes	Account SID
`CO`	path · string (CO… SID)	yes

Request body (2 fields)

Request body
Name	Type	Required	Description
`conversationVersion`	integer (1–)	yes
`reason`	string (max 1000 chars)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Snooze a conversation until a durable follow-up time

POST /v1/accounts/{AC}/conversations/{CO}/snooze

postV1AccountsByAcConversationsByCoSnoozeIdempotency-Key required200

Account-scoped credential: Required scope: `conversations:write`. Alternatively, a normal tenant USER session may use `conversations:write` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes	Account SID
`CO`	path · string (CO… SID)	yes

Request body (3 fields)

Request body
Name	Type	Required
`conversationVersion`	integer (1–)	yes
`reason`	string (max 1000 chars)	yes
`until`	string (date-time)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Add a conversation tag

POST /v1/accounts/{AC}/conversations/{CO}/tags/{tag}

postV1AccountsByAcConversationsByCoTagsByTagIdempotency-Key required200

Account-scoped credential: Required scope: `conversations:write`. Alternatively, a normal tenant USER session may use `conversations:write` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes	Account SID
`CO`	path · string (CO… SID)	yes
`tag`	path · string (pattern ^[a-z0-9][a-z0-9_-]{0,39}$)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Remove a conversation tag

DELETE /v1/accounts/{AC}/conversations/{CO}/tags/{tag}

deleteV1AccountsByAcConversationsByCoTagsByTag200

Account-scoped credential: Required scope: `conversations:write`. Alternatively, a normal tenant USER session may use `conversations:write` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes	Account SID
`CO`	path · string (CO… SID)	yes
`tag`	path · string (pattern ^[a-z0-9][a-z0-9_-]{0,39}$)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Return a snoozed conversation to its queue

POST /v1/accounts/{AC}/conversations/{CO}/unsnooze

postV1AccountsByAcConversationsByCoUnsnoozeIdempotency-Key required200

Account-scoped credential: Required scope: `conversations:write`. Alternatively, a normal tenant USER session may use `conversations:write` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes	Account SID
`CO`	path · string (CO… SID)	yes

Request body (2 fields)

Request body
Name	Type	Required	Description
`conversationVersion`	integer (1–)	yes
`reason`	string (max 1000 chars)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

List account saved replies

GET /v1/accounts/{AC}/saved-replies

getV1AccountsByAcSavedRepliesPaginated200

Required scope: `conversations:read`.

Parameters

Parameters
Name	Type	Required	Description
`limit`	query · integer (1–100)
`cursor`	query · string (max 2048 chars)
`AC`	path · string (AC… SID)	yes	Account SID

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Create a saved reply

POST /v1/accounts/{AC}/saved-replies

postV1AccountsByAcSavedRepliesIdempotency-Key required201

Required scope: `conversations:write`.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes	Account SID

Request body (3 fields)

Request body
Name	Type	Required
`body`	string (max 20000 chars)	yes
`shortcut`	string (pattern ^[a-z0-9][a-z0-9_-]{0,39}$)	yes
`title`	string (max 128 chars)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Update a saved reply

PATCH /v1/accounts/{AC}/saved-replies/{SR}

patchV1AccountsByAcSavedRepliesBySrIdempotency-Key required200

Required scope: `conversations:write`.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes	Account SID
`SR`	path · string (SR… SID)	yes

Request body (3 fields)

Request body
Name	Type	Required
`body`	string (max 20000 chars)	yes
`shortcut`	string (pattern ^[a-z0-9][a-z0-9_-]{0,39}$)	yes
`title`	string (max 128 chars)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Delete a saved reply

DELETE /v1/accounts/{AC}/saved-replies/{SR}

deleteV1AccountsByAcSavedRepliesBySr200

Required scope: `conversations:write`.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes	Account SID
`SR`	path · string (SR… SID)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

List the immutable versions of a saved reply, newest first

GET /v1/accounts/{AC}/saved-replies/{SR}/versions

getV1AccountsByAcSavedRepliesBySrVersions200

Required scope: `conversations:read`.

Parameters

Parameters
Name	Type	Required	Description
`limit`	query · integer (1–100)
`AC`	path · string (AC… SID)	yes	Account SID
`SR`	path · string (SR… SID)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.