> ## Documentation Index
> Fetch the complete documentation index at: https://wordsmithai.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Playbook

> Rename a playbook or change its description.

> [!NOTE]
>
> **Preview.** This endpoint is available to organisations in the Wordsmith MCP pilot. Other organisations receive `403 mcp_not_enabled`. See the [preview overview](/preview).

Changes a [playbook](/proposed/objects#playbook-and-check)'s `name` or `description`. Send only the fields you want to change. To change its checks, use [Add Check](/api-reference/playbooks/add-check), [Update Check](/api-reference/playbooks/update-check) and [Delete Check](/api-reference/playbooks/delete-check).

You need edit access to the playbook. Global playbooks cannot be changed.

## Authentication

Requires an API key, or an OAuth token with `playbooks:write`.

## Path parameters

**playbook\_id** `string` *required*

The playbook to change.

## Body parameters

**name** `string`

The new name, up to 200 characters.

**description** `string | null`

The new description, up to 2,000 characters. Send `null` to clear it.

## Response

Returns `200` with the updated [playbook](/proposed/objects#playbook-and-check), including its `checks`.

```bash cURL theme={null}
curl -X PATCH "https://api.wordsmith.ai/api/v1/playbooks/3804d3f1-ba8c-4d5e-97f7-c16466d0ece9" \
  -H "Authorization: Bearer sk-ws-api1-your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Our standard positions on inbound mutual NDAs. Reviewed October 2026."
  }'
```

```json Response theme={null}
{
  "id": "3804d3f1-ba8c-4d5e-97f7-c16466d0ece9",
  "name": "Mutual NDA – customer side",
  "description": "Our standard positions on inbound mutual NDAs. Reviewed October 2026.",
  "checks": [
    {
      "id": "e7d8a901-22b3-4c73-8362-0af4a7715c18",
      "name": "Term of confidentiality",
      "instructions": "Find how long the confidentiality obligations last after termination.",
      "severity": "high",
      "standard_position": "Obligations last no more than 3 years after termination.",
      "fallback_positions": [
        "Up to 5 years, if trade secrets are protected for as long as they remain secret."
      ]
    }
  ],
  "created_at": "2026-10-13T08:40:00Z",
  "updated_at": "2026-10-13T10:02:17Z"
}
```

## Errors

| Status | `error_code` | When |
| - | - | - |
| 400 | `invalid_request_body` | `name` is empty or too long, or `description` is over 2,000 characters. |
| 403 | `forbidden` | The caller can read the playbook but not edit it, or it is a global playbook. |
| 404 | `resource_not_found` | No playbook with this id, or the caller cannot read it. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.