View all methods

snapshots.settings.csatSelection.set

Set the complete CSAT selection. Omitted IDs are deselected; groups and ordering are preserved.

Facts

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

Arguments

Name Type Description
token Token Auth token passed as an HTTP header.
branch_id Text Required when branching is enabled; omit when disabled. Get IDs from snapshots.settings.branches.
csat_ids Array<Text> Required. Complete set of selected IDs from library, without duplicates.

Example request

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

Example response

{
  "ok": true,
  "selection": {
    "branch_id": "NTIxMDA",
    "csat": [
      {
        "id": "NTI5Njc",
        "name": "Build platform",
        "prompt": "How satisfied are you with the build platform?"
      }
    ]
  }
}

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.