PUT/api/csat/config

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.

Endpoint requirements

Credentials: Use either Bearer API key or X-API-Key header.
Required scope: csat:write
Module: Automation & API module (automation_api)
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.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body accepted by this operation.

Response Body

`application/json`

{
  "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"
    }
  ]
}

{
  "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"
  }
}

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?

Update CSAT configuration

Updates CSAT survey settings for the organization.

PUT/api/csat/config

Endpoint requirements

Credentials: Use either Bearer API key or X-API-Key header.
Required scope: csat:write
Module: Automation & API module (automation_api)
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.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body accepted by this operation.

enabled?boolean

Whether this feature is enabled.

surveyDelay?integer

Value of surveyDelay.

ratingScale?string

Rating scale. Allowed values: stars5, thumbs, nps10.

showCommentField?boolean

Boolean value stored in showCommentField.

triggerTiming?string

Trigger timing. Allowed values: after_close, after_handoff, manual.

notifyOnLowScore?boolean

Boolean value stored in notifyOnLowScore.

lowScoreThreshold?integer

Value of lowScoreThreshold.

followUpMaxRating?|

Value of followUpMaxRating.

translations?array<>

Localized variants for this resource.

Response Body

`application/json`

{
  "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"
    }
  ]
}

{
  "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"
  }
}

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?

Update CSAT configuration

Endpoint requirements

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Request examples

curl

JavaScript

On this page

Update CSAT configuration

Endpoint requirements

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Request examples

curl

JavaScript

On this page

Update CSAT configuration

Endpoint requirements

200application/json

400application/json

401application/json

402application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

On this page

Update CSAT configuration

Endpoint requirements

200application/json

400application/json

401application/json

402application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`