snapshots.settings.workflowSelection.set

Set the complete workflow selection. Omitted IDs are deselected; required workflows must remain selected.

Facts


Method	`POST https://api.getdx.com/snapshots.settings.workflowSelection.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`.
`workflow_ids`	`Array<Text>`	Required. Complete set of selected IDs from `library`, without duplicates.

Example request

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

Example response

{
  "ok": true,
  "selection": {
    "branch_id": "NTIxMDA",
    "workflows": [
      {
        "id": "NTIzMTM",
        "name": "Build time",
        "prompt": "How long does a build take?"
      }
    ]
  }
}

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.