View all methods

snapshots.settings.csatOrder.set

Set account-wide CSAT order, including unselected items. Provide either list or both; omitted lists keep their order. Selections and group membership are preserved.

Facts

Method POST https://api.getdx.com/snapshots.settings.csatOrder.set
Required scope snapshots:admin

Arguments

Name Type Description
token Token Auth token passed as an HTTP header.
csat_ids Array<Text> Complete ordered set of every CSAT library ID, exactly once.
group_ids Array<Text> Complete ordered set of every CSAT group ID, exactly once. Requires CSAT grouping.

Get the complete item and group IDs from snapshots.settings.library. The response contains both resulting lists; group_ids is null when grouping is disabled.

Example request

curl -X POST https://api.getdx.com/snapshots.settings.csatOrder.set \
  -H 'Authorization: Bearer xxxx-xxxxxxxxx-xxxx' \
  -H 'Content-Type: application/json' \
  --data '{
  "csat_ids": ["NTI5Njc"]
}'

Example response

{
  "ok": true,
  "csat_ids": ["NTI5Njc"],
  "group_ids": null
}

Errors

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