Satisfaction surveys

API reference descriptions are provided in English to preserve the exact published contract.

GETRead the survey decision for a conversationconversations.csatSurveys.list
POSTCreate a survey for a closed conversationconversations.csatSurveys.create
POSTAsk the platform to re-evaluate a refused surveyconversations.csatSurveys.reEvaluate
POSTLink a dispatched survey to its messagecsatSurveys.dispatched
GETReport customer satisfaction outcomes by inbox and agentcsat.analytics.list
GETGet customer satisfaction survey settingscsat.settings.list
PUTConfigure customer satisfaction surveyscsat.settings.update
GETRead a public customer satisfaction surveycsat.retrieve
POSTSubmit a public customer satisfaction responsecsat.responses

Read the survey decision for a conversation

GET/v1/accounts/{AC}/conversations/{CO}/csat-surveys

conversations.csatSurveys.listSDK operation getV1AccountsByAcConversationsByCoCsatSurveys

: 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

COstring (CO… SID)Required

GET /v1/accounts/{AC}/conversations/{CO}/csat-surveys

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

Responses

Create a survey for a closed conversation

POST/v1/accounts/{AC}/conversations/{CO}/csat-surveys

conversations.csatSurveys.createSDK operation postV1AccountsByAcConversationsByCoCsatSurveys

Required scope: conversations:write.Idempotency-Key required

Parameters

COstring (CO… SID)Required

POST /v1/accounts/{AC}/conversations/{CO}/csat-surveys

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

Responses

Ask the platform to re-evaluate a refused survey

POST/v1/accounts/{AC}/conversations/{CO}/csat-surveys/re-evaluate

conversations.csatSurveys.reEvaluateSDK operation postV1AccountsByAcConversationsByCoCsatSurveysReEvaluate

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.Idempotency-Key required

Parameters

COstring (CO… SID)Required

POST /v1/accounts/{AC}/conversations/{CO}/csat-surveys/re-evaluate

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

Responses

Link a dispatched survey to its message

POST/v1/accounts/{AC}/csat-surveys/{SV}/dispatched

csatSurveys.dispatchedSDK operation postV1AccountsByAcCsatSurveysBySvDispatched

Required scope: inboxes:write.Idempotency-Key required

Parameters

SVstring (SV… SID)Required

Request body

messageSidstring (SM… SID)Required

POST /v1/accounts/{AC}/csat-surveys/{SV}/dispatched

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/csat-surveys/SV.../dispatched" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "messageSid": "SM..."
}'

Responses

Report customer satisfaction outcomes by inbox and agent

GET/v1/accounts/{AC}/csat/analytics

csat.analytics.listSDK operation getV1AccountsByAcCsatAnalytics

Required scope: analytics:read.

GET /v1/accounts/{AC}/csat/analytics

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

Responses

Get customer satisfaction survey settings

GET/v1/accounts/{AC}/csat/settings

csat.settings.listSDK operation getV1AccountsByAcCsatSettings

Required scope: analytics:read.

GET /v1/accounts/{AC}/csat/settings

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

Responses

Configure customer satisfaction surveys

PUT/v1/accounts/{AC}/csat/settings

csat.settings.updateSDK operation putV1AccountsByAcCsatSettings

Required scope: inboxes:write.Idempotency-Key required

Request body

enabledbooleanRequired
maximumRatinginteger (1–10)Required
minimumRatinginteger (0–9)Required
requireServiceConsentbooleanRequired
responseWindowDaysinteger (1–90)Required
retainDaysinteger (1–3650)Required
contentSidstring (HX… SID)
senderSidstring (WA… SID)

PUT /v1/accounts/{AC}/csat/settings

curl -X PUT "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/csat/settings" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "enabled": true,
  "maximumRating": 1,
  "minimumRating": 0,
  "requireServiceConsent": true,
  "responseWindowDays": 1,
  "retainDays": 1
}'

Responses

Read a public customer satisfaction survey

GET/v1/csat/{SV}

csat.retrieveSDK operation getV1CsatBySv

No key needed

Parameters

tokenstring (max 256 chars)queryRequired
SVstring (SV… SID)Required

GET /v1/csat/{SV}

curl "https://api.staging.toutye.com/v1/csat/SV...?token=string" \
  -H "Toutye-Version: 2026-08-21"

Responses

Submit a public customer satisfaction response

POST/v1/csat/{SV}/responses

csat.responsesSDK operation postV1CsatBySvResponses

Idempotency-Key requiredNo key needed

Parameters

SVstring (SV… SID)Required

Request body

ratinginteger (0–10)Required
tokenstring (max 256 chars)Required
commentstring (max 2000 chars)

POST /v1/csat/{SV}/responses

curl -X POST "https://api.staging.toutye.com/v1/csat/SV.../responses" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "rating": 0,
  "token": "string"
}'

Responses