Update Playbook

Rename a playbook or change its description.

PATCH /api/v1/playbooks/{playbook_id}

cURL

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."
  }'

Response

{
  "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"
}

Preview. This endpoint is available to organisations in the Wordsmith MCP pilot. Other organisations receive 403 mcp_not_enabled. See the preview overview.

Changes a playbook’s name or description. Send only the fields you want to change. To change its checks, use Add Check, Update Check and 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, including its checks.

cURL

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."
  }'

Response

{
  "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.