API reference descriptions are provided in English to preserve the exact published contract.
GET /v1/accounts/{AC}/conversations/{CO}/csat-surveys
: every closed conversation under an enabled policy carries exactly one survey decision, made by the platform. The list holds that decision or nothing. Required scope: `conversations:read`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
AC | path · string | yes | |
CO | path · string (CO… SID) | yes |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
POST /v1/accounts/{AC}/conversations/{CO}/csat-surveys
Required scope: `conversations:write`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
AC | path · string | yes | |
CO | path · string (CO… SID) | yes |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
POST /v1/accounts/{AC}/conversations/{CO}/csat-surveys/re-evaluate
Only a CANCELED decision can be re-evaluated; the maintenance worker re-runs eligibility and either dispatches the survey or records the new refusal reason. Required scope: `conversations:write`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
AC | path · string | yes | |
CO | path · string (CO… SID) | yes |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
POST /v1/accounts/{AC}/csat-surveys/{SV}/dispatched
Required scope: `inboxes:write`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
AC | path · string | yes | |
SV | path · string (SV… SID) | yes |
| Name | Type | Required | Description |
|---|---|---|---|
messageSid | string (SM… SID) | yes |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
GET /v1/accounts/{AC}/csat/analytics
Required scope: `analytics: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.
GET /v1/accounts/{AC}/csat/settings
Required scope: `analytics: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.
PUT /v1/accounts/{AC}/csat/settings
Required scope: `inboxes:write`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
AC | path · string (AC… SID) | yes | Account SID |
| Name | Type | Required | Description |
|---|---|---|---|
contentSid | string (HX… SID) | ||
enabled | boolean | yes | |
maximumRating | integer (1–10) | yes | |
minimumRating | integer (0–9) | yes | |
requireServiceConsent | boolean | yes | |
responseWindowDays | integer (1–90) | yes | |
retainDays | integer (1–3650) | yes | |
senderSid | string (WA… SID) |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
GET /v1/csat/{SV}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
token | query · string (max 256 chars) | yes | |
SV | path · string (SV… SID) | yes |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
POST /v1/csat/{SV}/responses
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
SV | path · string (SV… SID) | yes |
| Name | Type | Required | Description |
|---|---|---|---|
comment | string (max 2000 chars) | ||
rating | integer (0–10) | yes | |
token | string (max 256 chars) | yes |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.