The AI assistant's settings
GET /v1/accounts/{AC}/assistant
Required scope: `inboxes:read`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
AC | path · string (AC… SID) | yes | Account SID |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
Assistant
API reference descriptions are provided in English to preserve the exact published contract.
Set the AI assistant: on or off, what the business is, tone, hand-off
PUT /v1/accounts/{AC}/assistant
Required scope: `inboxes:write`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
AC | path · string (AC… SID) | yes | Account SID |
Request body (7 fields)
| Name | Type | Required | Description |
|---|---|---|---|
businessSummary | string (max 2000 chars) | yes | |
enabled | boolean | yes | |
handoffInboxSid | string (IB… SID) | null | yes | |
handoffMessage | string (max 1000 chars) | yes | |
language | string (max 16 chars) | yes | |
neverAnswer | string (max 120 chars)[] | yes | |
tone | "FRIENDLY" | "FORMAL" | "BRIEF" | yes |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
The knowledge base the assistant answers from
GET /v1/accounts/{AC}/assistant/articles
Required scope: `inboxes:read`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
AC | path · string (AC… SID) | yes | Account SID |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
Add a knowledge article
POST /v1/accounts/{AC}/assistant/articles
Required scope: `inboxes:write`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
AC | path · string (AC… SID) | yes | Account SID |
Request body (2 fields)
| Name | Type | Required | Description |
|---|---|---|---|
body | string (max 8000 chars) | yes | |
title | string (max 200 chars) | yes |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
Remove a knowledge article
DELETE /v1/accounts/{AC}/assistant/articles/{KA}
Required scope: `inboxes:write`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
AC | path · string | yes | |
KA | path · string (KA… SID) | yes |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
Pause or explicitly resume automatic AI replies for one conversation
PUT /v1/accounts/{AC}/assistant/conversations/{CO}
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
| Name | Type | Required | Description |
|---|---|---|---|
AC | path · string (AC… SID) | yes | Account SID |
CO | path · string (CO… SID) | yes |
Request body (2 fields)
| Name | Type | Required | Description |
|---|---|---|---|
conversationVersion | integer (1–) | yes | |
paused | boolean | yes |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
Draft a reply to a conversation from the knowledge base (does not send)
POST /v1/accounts/{AC}/assistant/draft
Required scope: `conversations:write`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
AC | path · string (AC… SID) | yes | Account SID |
Request body (1 fields)
| Name | Type | Required | Description |
|---|---|---|---|
conversationSid | string (CO… SID) | yes |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.