---
title: "Update a playbook"
method: PATCH
path: "/playbooks/{id}"
tags: ["Playbooks"]
---

# Update a playbook

`PATCH /playbooks/{id}`

## Request

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

Update a playbook's title, description, or guide. At least one field is required.

User-scoped keys require write access to the playbook. Org-scoped keys can update org-visible (non-private) playbooks.

## Path parameters

- `id` string, uuid, required: The playbook ID

## Request body

- UpdatePlaybookRequest
  - `title` string: New title (non-empty).
  - `description` string, nullable: New description, or null to clear.
  - `guide` string, nullable: New guide text, or null to clear.

## Response `200`

Updated playbook

- Playbook
  - `id` string, uuid, required: Unique playbook identifier
  - `title` string, required: Playbook title
  - `description` string, nullable, required: Playbook description, or null if unset
  - `guide` string, nullable, required: Free-text guidance applied across the whole playbook when it runs, or null if unset.
  - `is_official` boolean, required: Whether this is an official GC AI playbook
  - `status` 'draft' | 'processing' | 'completed' | 'failed', required: Playbook processing status
  - `created_at` string, nullable, required: ISO 8601 creation timestamp
  - `updated_at` string, nullable, required: ISO 8601 last-update timestamp

## Other responses

- `400`: Invalid request body
- `401`: Missing or malformed API key
- `403`: Invalid API 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)