Update CSAT configuration
Updates CSAT survey settings for the organization.
/api/csat/configUpdates CSAT survey settings for the organization. Admin access is required. The body is partial, so omitted fields keep their current value or the default values from GET /api/csat/config. ratingScale is fixed at 5, surveyDelay can be 0 to 60 minutes, and triggerTiming can be after_close, after_handoff, or manual.
Endpoint requirements
- Credentials
- Use either
Bearer API keyorX-API-Key header. - Required scope
csat:write- Module
- Automation & API module (
api_access) - Organization and site scope
- Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
- Retry behavior
- Convergent write: Retrying leaves the resource in the same resulting state. If the first request succeeded, a later retry may return conflict or not found because the change has already taken effect.
Header Parameters
DA-4035: selects the active site (project) for project-scoped operations. Accepts a site UUID, or the literal all to aggregate across every accessible site on read-only aggregate routes (single-or-all-read). Mutations and single-site routes reject all. Path-owned project routes (/api/projects/{projectId}/…) resolve the site from the URL and ignore this header. Conflicting selectors across header/query/body/path return PROJECT_CONTEXT_CONFLICT (400); an archived site returns PROJECT_ARCHIVED (410).
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request body accepted by this operation.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
{ "projectId": "11111111-1111-4111-8111-111111111111", "enabled": true, "surveyDelay": 5, "questionText": "How was your support experience?", "commentPlaceholder": "example", "followUpQuestionText": "example", "followUpPlaceholder": "example", "thankYouTitle": "Example title", "thankYouText": "example", "ratingScale": "stars5", "showCommentField": true, "triggerTiming": "after_close", "notifyOnLowScore": true, "lowScoreThreshold": 1, "followUpMaxRating": 1, "locale": "en", "fallbackUsed": true, "translations": [ { "locale": "en", "status": "draft", "sourceLocale": "en", "machineTranslatedAt": "2026-08-04T10:00:00.000Z", "reviewedAt": "2026-08-04T10:00:00.000Z", "reviewedBy": "example", "questionText": "example", "commentPlaceholder": "example", "followUpQuestionText": "example", "followUpPlaceholder": "example", "thankYouTitle": "Example title", "thankYouText": "example", "createdAt": "2026-08-04T10:00:00.000Z", "updatedAt": "2026-08-04T10:00:00.000Z" } ]}Request examples
curl
curl --request PUT \
'https://api.convor.io/api/csat/config' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...' \
--header 'Content-Type: application/json' \
--data '{
"enabled": true,
"surveyDelay": 5,
"ratingScale": "stars5",
"showCommentField": true,
"triggerTiming": "after_close"
}'JavaScript
const response = await fetch("https://api.convor.io/api/csat/config", {
method: "PUT",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_...",
"Content-Type": "application/json"
},
body: JSON.stringify({
"enabled": true,
"surveyDelay": 5,
"ratingScale": "stars5",
"showCommentField": true,
"triggerTiming": "after_close"
}),
});
const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
? null
: contentType.includes("json")
? await response.json()
: contentType.startsWith("text/")
? await response.text()
: await response.blob();
if (!response.ok) {
const message = typeof data === "object" && data !== null
&& "error" in data && typeof data.error === "object"
&& data.error !== null && "message" in data.error
? String(data.error.message)
: "Convor API request failed (" + response.status + ")";
throw new Error(message);
}
console.log(data);Was this page helpful?