---
title: "Reorder a playbook's checks"
method: POST
path: "/playbooks/{id}/checks/reorder"
tags: ["Playbooks"]
---

# Reorder a playbook's checks

`POST /playbooks/{id}/checks/reorder`

## Request

- Base URL: `https://app.gc.ai/api/external/v1`
- URL: `https://app.gc.ai/api/external/v1/playbooks/{id}/checks/reorder`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/gc-ai/apis/gc-ai-external-api/docs/playbooks/:id/checks/reorder/post.ts> (a function with typed inputs; its response is checked against the schema)

Set the order of the playbook's checks. Provide the check IDs in the desired order.

Requires a user-scoped key with write access to the playbook. Org-scoped keys cannot reorder checks.

## Path parameters

- `id` string, uuid, required: Playbook ID from `GET /playbooks`.

## Request body

- ReorderPlaybookChecksRequest
  - `check_ids` string[], required: All check IDs of the playbook in the desired order. Checks omitted from the list keep their existing order relative to one another.

## Response `200`

Checks reordered

- ReorderPlaybookChecksResponse
  - `reordered` boolean, required: Always `true` on success

## Other responses

- `400`: Invalid request body
- `401`: Missing or malformed API key
- `403`: Reordering checks requires a user-scoped key
- `404`: Playbook not found or not writable by the caller
- `429`: Rate limit exceeded. See [Rate Limits](https://docs.gc.ai/api-reference/concepts/rate-limits) for the tiers, limits, and how to back off.
- `500`: Internal server error
- `503`: Service temporarily unavailable

---

[API](https://skmtc.dev/gc-ai/apis/gc-ai-external-api.md) - [All operations](https://skmtc.dev/gc-ai/apis/gc-ai-external-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gc-ai/apis/gc-ai-external-api/revisions/2bbdfddf7107?raw)