Skip to main content
POST
/
playbooks
/
{id}
/
checks
/
reorder
Reorder a playbook's checks
curl --request POST \
  --url https://app.gc.ai/api/external/v1/playbooks/{id}/checks/reorder \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "check_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
{
  "reordered": true
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Format: gcai_xxxxxxxxx

Create API keys in the GC AI app under Settings → API.

Path Parameters

​
id
string<uuid>
required

Playbook ID from GET /playbooks.

Body

application/json
​
check_ids
string<uuid>[]
required

All check IDs of the playbook in the desired order. Checks omitted from the list keep their existing order relative to one another.

Minimum array length: 1

Response

Checks reordered

​
reordered
boolean
required

Always true on success