Conversations API · Toutye docs

List customer-controlled bot applications

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

botApplications.listSDK operation getV1AccountsByAcBotApplications

Required scope: inboxes:read.Paginated

Parameters

limitinteger (1–100)query
cursorstring (max 2048 chars)query

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

curl "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/bot-applications" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Create a customer-controlled bot application

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

botApplications.createSDK operation postV1AccountsByAcBotApplications

Required scope: inboxes:write.Idempotency-Key required

Request body

fallbackInboxSidstring (IB… SID)Required
namestring (max 128 chars)Required
principalRefstring (max 128 chars)Required
webhookEndpointSidstring (WH… SID)Required
timeoutSecondsinteger (5–3600)

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

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/bot-applications" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "fallbackInboxSid": "IB...",
  "name": "string",
  "principalRef": "string",
  "webhookEndpointSid": "WH..."
}'

Responses

Update a customer-controlled bot application

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

botApplications.updateSDK operation patchV1AccountsByAcBotApplicationsByBa

Required scope: inboxes:write.Idempotency-Key required

Parameters

BAstring (BA… SID)Required

Request body

fallbackInboxSidstring (IB… SID)
namestring (max 128 chars)
principalRefstring (max 128 chars)
timeoutSecondsinteger (5–3600)
webhookEndpointSidstring (WH… SID)

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

curl -X PATCH "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/bot-applications/BA..." \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)"

Responses

Disable a bot application when it has no active handoff

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

botApplications.deleteSDK operation deleteV1AccountsByAcBotApplicationsByBa

Required scope: inboxes:write.

Parameters

BAstring (BA… SID)Required

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

curl -X DELETE "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/bot-applications/BA..." \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

List authorized conversations and collaboration state

GET/v1/accounts/{AC}/conversations

conversations.listSDK operation getV1AccountsByAcConversations

List conversations you may see, with their state, assignee and service-window expiry.

Required scope: conversations:read.Paginated

Inbox and dashboard sessions

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

inboxSidstring (IB… SID)query
senderSidstring (WA… SID)query
contactSidstring (CT… SID)query
activityFromstring (date-time)query
activityTostring (date-time)query
activityPrincipalstring (max 128 chars)query
stateenumquery
OPENIDLECLOSEDARCHIVED
assigneestring (max 128 chars)query
unassignedbooleanquery
openOnlybooleanquery
Only active OPEN or IDLE conversations; unlike state=OPEN this includes conversations waiting on the customer.
unreadbooleanquery
priorityenumquery
LOWNORMALHIGHURGENT
tagstring (pattern ^[a-z0-9][a-z0-9_-]{0,39}$)query
campaignSidstring (CP… SID)query
consentStateenumquery
OPTED_INOPTED_OUTUNKNOWNREVOKEDEXPIRED
riskFlagbooleanquery
slaStateenumquery
healthyat_riskbreached
snoozedbooleanquery
waitingbooleanquery
Only open conversations where the customer's last message has not been answered.
sortenumquery
recent (default): newest activity first. longest_waiting: the customer who has waited longest for a reply first; conversations nobody is waiting on come last.
recentlongest_waiting
createdAfterstring (date-time)query
createdBeforestring (date-time)query
limitinteger (1–100)query
cursorstring (max 2048 chars)query

GET /v1/accounts/{AC}/conversations

curl "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/conversations" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Search authorized conversations by identifier, contact and metadata

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

conversations.search.listSDK operation getV1AccountsByAcConversationsSearch

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.Paginated

Parameters

qstring (max 200 chars)queryRequired
inboxSidstring (IB… SID)query
senderSidstring (WA… SID)query
contactSidstring (CT… SID)query
activityFromstring (date-time)query
activityTostring (date-time)query
activityPrincipalstring (max 128 chars)query
tagstring (max 40 chars)query
assigneestring (max 128 chars)query
fromstring (date-time)query
tostring (date-time)query
limitinteger (1–100)query
cursorstring (max 2048 chars)query

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

curl "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/conversations/search?q=string" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Get a conversation

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

conversations.retrieveSDK operation getV1AccountsByAcConversationsByCo

Fetch one conversation with its assignment, tags and version.

Required scope: conversations:read.

Inbox and dashboard sessions

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

COstring (CO… SID)Required

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

curl "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/conversations/CO..." \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Assign a conversation

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

conversations.assignSDK operation postV1AccountsByAcConversationsByCoAssign

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.

Required scope: conversations:assign.Idempotency-Key required

Inbox and dashboard sessions

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

COstring (CO… SID)Required

Request body

assigneePrincipalRefstring (max 128 chars)Required
conversationVersioninteger (1–)Required
reasonstring (max 1000 chars)Required

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

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/conversations/CO.../assign" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "assigneePrincipalRef": "string",
  "conversationVersion": 1,
  "reason": "string"
}'

Responses

List audited assignment and handoff history

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

conversations.assignments.listSDK operation getV1AccountsByAcConversationsByCoAssignments

Required scope: conversations:read.Paginated

Inbox and dashboard sessions

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

COstring (CO… SID)Required
limitinteger (1–100)query
cursorstring (max 2048 chars)query

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

curl "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/conversations/CO.../assignments" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Acknowledge, activate, complete, or reject a bot handoff

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

conversations.botHandoffs.respondSDK operation postV1AccountsByAcConversationsByCoBotHandoffsByBhRespond

Required scope: conversations:write.Idempotency-Key required

Parameters

COstring (CO… SID)Required
BHstring (BH… SID)Required

Request body

outcomeenumRequired
ACCEPTACTIVECOMPLETEFAIL
reasonstring (max 1000 chars)

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

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/conversations/CO.../bot-handoffs/BH.../respond" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "outcome": "ACCEPT"
}'

Responses

Retry a failed or timed-out bot handoff

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

conversations.botHandoffs.retrySDK operation postV1AccountsByAcConversationsByCoBotHandoffsByBhRetry

Required scope: conversations:write.Idempotency-Key required

Inbox and dashboard sessions

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

COstring (CO… SID)Required
BHstring (BH… SID)Required

Request body

reasonstring (max 1000 chars)Required

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

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/conversations/CO.../bot-handoffs/BH.../retry" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "string"
}'

Responses

Take an active bot handoff back to its human fallback inbox

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

conversations.botHandoffs.takeoverSDK operation postV1AccountsByAcConversationsByCoBotHandoffsByBhTakeover

Required scope: conversations:write.Idempotency-Key required

Inbox and dashboard sessions

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

COstring (CO… SID)Required
BHstring (BH… SID)Required

Request body

reasonstring (max 1000 chars)Required

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

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/conversations/CO.../bot-handoffs/BH.../takeover" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "string"
}'

Responses

Acquire the exclusive composer claim

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

conversations.claimSDK operation postV1AccountsByAcConversationsByCoClaim

Required scope: conversations:write.Idempotency-Key required

Inbox and dashboard sessions

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

COstring (CO… SID)Required

Request body

conversationVersioninteger (1–)Required
leaseSecondsinteger (15–300)
overrideReasonstring (max 1000 chars)

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

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/conversations/CO.../claim" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "conversationVersion": 1
}'

Responses

Release the composer claim

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

conversations.claim.releaseSDK operation postV1AccountsByAcConversationsByCoClaimRelease

Required scope: conversations:write.Idempotency-Key required

Inbox and dashboard sessions

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

COstring (CO… SID)Required

Request body

leaseTokenstring (uuid)Required
leaseSecondsinteger (15–300)

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

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/conversations/CO.../claim/release" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "leaseToken": "3f2b1c9e-8d4a-4b5f-9a61-0c7e2d1b4a55"
}'

Responses

Renew the composer claim

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

conversations.claim.renewSDK operation postV1AccountsByAcConversationsByCoClaimRenew

Required scope: conversations:write.Idempotency-Key required

Inbox and dashboard sessions

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

COstring (CO… SID)Required

Request body

leaseTokenstring (uuid)Required
leaseSecondsinteger (15–300)

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

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/conversations/CO.../claim/renew" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "leaseToken": "3f2b1c9e-8d4a-4b5f-9a61-0c7e2d1b4a55"
}'

Responses

Close a conversation

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

conversations.closeSDK operation postV1AccountsByAcConversationsByCoClose

Close a conversation. Send the conversationVersion you last read.

Required scope: conversations:write.Idempotency-Key required

Inbox and dashboard sessions

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

COstring (CO… SID)Required

Request body

conversationVersioninteger (1–)Required
reasonstring (max 1000 chars)Required

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

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/conversations/CO.../close" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "conversationVersion": 1,
  "reason": "string"
}'

Responses

List conversation collaborators and followers

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

conversations.collaborators.listSDK operation getV1AccountsByAcConversationsByCoCollaborators

Required scope: conversations:read.

Inbox and dashboard sessions

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

COstring (CO… SID)Required

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

curl "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/conversations/CO.../collaborators" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Add a conversation collaborator

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

conversations.collaborators.updateSDK operation putV1AccountsByAcConversationsByCoCollaboratorsByPrincipalref

Required scope: conversations:write.Idempotency-Key required

Inbox and dashboard sessions

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

COstring (CO… SID)Required
principalRefstring (max 128 chars)Required

Request body

roleenumRequired
COLLABORATORFOLLOWER

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

curl -X PUT "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/conversations/CO.../collaborators/principalRef..." \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "role": "COLLABORATOR"
}'

Responses

Remove a conversation collaborator

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

conversations.collaborators.deleteSDK operation deleteV1AccountsByAcConversationsByCoCollaboratorsByPrincipalref

Required scope: conversations:write.

Inbox and dashboard sessions

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

COstring (CO… SID)Required
principalRefstring (max 128 chars)Required

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

curl -X DELETE "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/conversations/CO.../collaborators/principalRef..." \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

List retained message history for an authorized conversation

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

conversations.messages.listSDK operation getV1AccountsByAcConversationsByCoMessages

List the messages of a conversation, oldest first.

Required scope: conversations:read.Paginated

Inbox and dashboard sessions

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

COstring (CO… SID)Required
limitinteger (1–100)query
cursorstring (max 2048 chars)query

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

curl "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/conversations/CO.../messages" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

List encrypted internal notes

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

conversations.notes.listSDK operation getV1AccountsByAcConversationsByCoNotes

Required scope: conversations:read.Paginated

Inbox and dashboard sessions

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

COstring (CO… SID)Required
limitinteger (1–100)query
cursorstring (max 2048 chars)query

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

curl "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/conversations/CO.../notes" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Create an encrypted internal note

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

conversations.notes.createSDK operation postV1AccountsByAcConversationsByCoNotes

Required scope: conversations:note.Idempotency-Key required

Inbox and dashboard sessions

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

COstring (CO… SID)Required

Request body

bodystring (max 20000 chars)Required
mentionedPrincipalRefsstring (max 128 chars)[]

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

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/conversations/CO.../notes" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "body": "string"
}'

Responses

Edit an internal note

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

conversations.notes.updateSDK operation patchV1AccountsByAcConversationsByCoNotesByNt

Required scope: conversations:note.Idempotency-Key required

Inbox and dashboard sessions

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

COstring (CO… SID)Required
NTstring (NT… SID)Required

Request body

bodystring (max 20000 chars)Required
mentionedPrincipalRefsstring (max 128 chars)[]

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

curl -X PATCH "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/conversations/CO.../notes/NT..." \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "body": "string"
}'

Responses

Delete an internal note

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

conversations.notes.deleteSDK operation deleteV1AccountsByAcConversationsByCoNotesByNt

Required scope: conversations:note.

Inbox and dashboard sessions

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

COstring (CO… SID)Required
NTstring (NT… SID)Required
onlyIfUneditedbooleanquery

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

curl -X DELETE "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/conversations/CO.../notes/NT..." \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Read encrypted internal note revision history

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

conversations.notes.revisions.listSDK operation getV1AccountsByAcConversationsByCoNotesByNtRevisions

Required scope: conversations:read.Paginated

Inbox and dashboard sessions

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

COstring (CO… SID)Required
NTstring (NT… SID)Required
limitinteger (1–100)query
cursorstring (max 2048 chars)query

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

curl "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/conversations/CO.../notes/NT.../revisions" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Change conversation priority and recalculate its SLA clocks

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

conversations.prioritySDK operation postV1AccountsByAcConversationsByCoPriority

Required scope: conversations:write.Idempotency-Key required

Inbox and dashboard sessions

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

COstring (CO… SID)Required

Request body

conversationVersioninteger (1–)Required
priorityenumRequired
LOWNORMALHIGHURGENT
reasonstring (max 1000 chars)Required

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

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/conversations/CO.../priority" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "conversationVersion": 1,
  "priority": "LOW",
  "reason": "string"
}'

Responses

Advance this principal's read cursor

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

conversations.readSDK operation postV1AccountsByAcConversationsByCoRead

Required scope: conversations:write.Idempotency-Key required

Inbox and dashboard sessions

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

COstring (CO… SID)Required

Request body

lastReadMessageSidstring (SM… SID)

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

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/conversations/CO.../read" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)"

Responses

Release a conversation assignment

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

conversations.releaseSDK operation postV1AccountsByAcConversationsByCoRelease

Required scope: conversations:assign.Idempotency-Key required

Inbox and dashboard sessions

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

COstring (CO… SID)Required

Request body

conversationVersioninteger (1–)Required
reasonstring (max 1000 chars)Required

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

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/conversations/CO.../release" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "conversationVersion": 1,
  "reason": "string"
}'

Responses

Reopen a conversation

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

conversations.reopenSDK operation postV1AccountsByAcConversationsByCoReopen

Required scope: conversations:write.Idempotency-Key required

Inbox and dashboard sessions

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

COstring (CO… SID)Required

Request body

conversationVersioninteger (1–)Required
reasonstring (max 1000 chars)Required

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

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/conversations/CO.../reopen" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "conversationVersion": 1,
  "reason": "string"
}'

Responses

Snooze a conversation until a durable follow-up time

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

conversations.snoozeSDK operation postV1AccountsByAcConversationsByCoSnooze

Required scope: conversations:write.Idempotency-Key required

Inbox and dashboard sessions

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

COstring (CO… SID)Required

Request body

conversationVersioninteger (1–)Required
reasonstring (max 1000 chars)Required
untilstring (date-time)Required

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

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/conversations/CO.../snooze" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "conversationVersion": 1,
  "reason": "string",
  "until": "2026-10-25T09:00:00Z"
}'

Responses

Add a conversation tag

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

conversations.tags.updateSDK operation postV1AccountsByAcConversationsByCoTagsByTag

Required scope: conversations:write.Idempotency-Key required

Inbox and dashboard sessions

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

COstring (CO… SID)Required
tagstring (pattern ^[a-z0-9][a-z0-9_-]{0,39}$)Required

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

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/conversations/CO.../tags/tag..." \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)"

Responses

Remove a conversation tag

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

conversations.tags.deleteSDK operation deleteV1AccountsByAcConversationsByCoTagsByTag

Required scope: conversations:write.

Inbox and dashboard sessions

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

COstring (CO… SID)Required
tagstring (pattern ^[a-z0-9][a-z0-9_-]{0,39}$)Required
onlyIfAddedAtstring (date-time, max 64 chars)query

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

curl -X DELETE "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/conversations/CO.../tags/tag..." \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Return a snoozed conversation to its queue

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

conversations.unsnoozeSDK operation postV1AccountsByAcConversationsByCoUnsnooze

Required scope: conversations:write.Idempotency-Key required

Inbox and dashboard sessions

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

COstring (CO… SID)Required

Request body

conversationVersioninteger (1–)Required
reasonstring (max 1000 chars)Required

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

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/conversations/CO.../unsnooze" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "conversationVersion": 1,
  "reason": "string"
}'

Responses

List account saved replies

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

savedReplies.listSDK operation getV1AccountsByAcSavedReplies

Required scope: conversations:read.Paginated

Parameters

limitinteger (1–100)query
cursorstring (max 2048 chars)query

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

curl "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/saved-replies" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Create a saved reply

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

savedReplies.createSDK operation postV1AccountsByAcSavedReplies

Required scope: conversations:write.Idempotency-Key required

Request body

bodystring (max 20000 chars)Required
shortcutstring (pattern ^[a-z0-9][a-z0-9_-]{0,39}$)Required
titlestring (max 128 chars)Required

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

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/saved-replies" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "body": "string",
  "shortcut": "string",
  "title": "string"
}'

Responses

Update a saved reply

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

savedReplies.updateSDK operation patchV1AccountsByAcSavedRepliesBySr

Required scope: conversations:write.Idempotency-Key required

Parameters

SRstring (SR… SID)Required

Request body

bodystring (max 20000 chars)Required
shortcutstring (pattern ^[a-z0-9][a-z0-9_-]{0,39}$)Required
titlestring (max 128 chars)Required

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

curl -X PATCH "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/saved-replies/SR..." \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "body": "string",
  "shortcut": "string",
  "title": "string"
}'

Responses

Delete a saved reply

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

savedReplies.deleteSDK operation deleteV1AccountsByAcSavedRepliesBySr

Required scope: conversations:write.

Parameters

SRstring (SR… SID)Required

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

curl -X DELETE "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/saved-replies/SR..." \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

List the immutable versions of a saved reply, newest first

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

savedReplies.versions.listSDK operation getV1AccountsByAcSavedRepliesBySrVersions

Required scope: conversations:read.

Parameters

SRstring (SR… SID)Required
limitinteger (1–100)query

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

curl "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/saved-replies/SR.../versions" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses