Updates 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`. Access requires an active organization administrator session or an organization API key with the `csat:write` scope. API-key calls also require the automation API module. Data is isolated to the authenticated organization; identifiers from another organization or site are not disclosed.
/api/csat/configOrganization API key supplied as Authorization: Bearer convor_sk_....
In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
{
"enabled": true,
"surveyDelay": 5,
"questionText": "How was your support experience?",
"ratingScale": 5,
"showCommentField": true,
"triggerTiming": "after_close"
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication is required.",
"correlationId": "req_01K0MANAGEMENT401"
}
}{
"error": {
"code": "INTEGRATION_MODULE_REQUIRED",
"message": "The automation API module is required.",
"details": {
"module": "automation_api",
"feature": "public_api"
},
"correlationId": "req_01K0MANAGEMENT402"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "The caller lacks the required role or API-key scope.",
"correlationId": "req_01K0MANAGEMENT403"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "The requested resource was not found.",
"correlationId": "req_01K0MANAGEMENT404"
}
}{
"error": {
"code": "CONFLICT",
"message": "The requested change conflicts with current resource state.",
"correlationId": "req_01K0MANAGEMENT409"
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "The request payload is invalid.",
"details": {
"field": "name"
},
"correlationId": "req_01K0MANAGEMENT422"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Too many requests.",
"correlationId": "req_01K0MANAGEMENT429"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}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,
"questionText": "How was your support experience?",
"ratingScale": 5,
"showCommentField": true,
"triggerTiming": "after_close"
}'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,
"questionText": "How was your support experience?",
"ratingScale": 5,
"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?
Update a survey
Updates one existing survey response in the current organization. The request body is partial, so you can change the rating, the comment, or both without resending unchanged fields. The survey must already exist in the same organization. Use this for back-office corrections rather than new visitor submissions. Authenticate with an organization API key sent in `X-API-Key` or as a Bearer token and carrying the exact `surveys:write` scope. API-key access also requires the Automation & API module (`automation_api`). Authorized dashboard sessions remain supported where the route already permits them. The request is isolated to the authenticated organization. Resource and site/project identifiers must belong to that organization; out-of-scope identifiers are not disclosed. This back-office correction endpoint accepts a partial body containing `rating`, `comment`, or both. Ratings are stable integers from 1 through 3. Visitor submission is intentionally not performed through this operation. The unauthenticated `POST /api/surveys` visitor-token flow is a protocol route and is not part of the organization API-key contract. Retry behavior: Repeating the same request converges on the same resource state, but a retry may return a conflict or not-found response after the first request succeeds.
Departments
Support departments and operator membership