View all methods

snapshots.settings.csatItems.update

Update a CSAT item. Omitted fields keep their values; audience changes require the complete filter object.

Facts
Method POST https://api.getdx.com/snapshots.settings.csatItems.update
Required scope snapshots:admin

Arguments

Name Type Description
token Token Auth token passed as an HTTP header.
csat_id Text Required. CSAT item ID from snapshots.settings.library.
name Text Optional. Item name.
prompt Text Optional. Survey question.
audience_filters Object Optional. Complete audience filter object; see below.
exclude_na_responders Boolean Optional. Whether to exclude N/A responders.
group_id Text or null Optional. Existing CSAT group ID, or null to ungroup. Requires CSAT grouping.
translations Object Optional locale-to-fields map, e.g. {"fr": {"name": "Exemple"}}. Uses enabled translation locales.

See the audience filter input format.

Translations support name and prompt. Rewording clears existing translations unless replacements are supplied; an empty string clears a translation.

Example request

curl -X POST https://api.getdx.com/snapshots.settings.csatItems.update \
  -H 'Authorization: Bearer xxxx-xxxxxxxxx-xxxx' \
  -H 'Content-Type: application/json' \
  --data '{
  "csat_id": "NTI5Njc",
  "name": "Build platform"
}'

Example response

{
  "ok": true,
  "csat": {
    "id": "NTI5Njc",
    "name": "Build platform",
    "prompt": "How satisfied are you with the build platform?",
    "exclude_na_responders": false,
    "translations": {},
    "group_id": null,
    "audience_filters": {
      "type": "configured",
      "configured": {
        "target_role": "all",
        "teams": [],
        "attributes": []
      },
      "custom": null,
      "active_users": null
    }
  }
}

Errors

not_authed or not_authorized for missing authentication or access. not_found for unavailable item IDs. 422 validation_error for invalid input (error_details explains why); 409 snapshot_live while a snapshot is live.