Skip to content
X-Buddy
Tiếng Việt

API reference

Delete a playbook

playbook_delete — Delete a playbook.

Markdown version

playbook_delete · Delete / cannot be undone

Delete a playbook. Tasks it copied onto accounts stay. expected_revision required.
REST DELETE /api/public/v1/playbooks/{playbook_id}
MCP tool playbook_delete
Permission needed tasks.manage — Owner, Manager, Operator
Scope group automation:write
Group Tasks and playbooks
Shown up front in profiles —

Input

Field Type Required Description
playbook_id string (uuid) Yes Playbook id.
expected_revision integer (1–∞) Yes The revision you read (optimistic locking); a newer revision fails with revision_conflict.

Result

Returns the operation's result in the { data, meta } envelope.

Needs an idempotency key (Idempotency-Key, 8–128 characters). Retrying with the same key never repeats the action.

Versioned setting: send the expected_revision (or If-Match) you read, or the write is refused.

This deletes data or can't be undone. Ask the person before calling it.

Example

Call over REST

curl -X DELETE "https://reach-link-craft.lovable.app/api/public/v1/playbooks/00000000-0000-4000-8000-000000000001" \
  -H "Authorization: Bearer $XBUDDY_API_KEY" \
  -H "Idempotency-Key: 6f1c2a90-example-key" \
  -H 'If-Match: "3"' \
  -H "Content-Type: application/json" \
  -d '{"expected_revision":1}'

Call over MCP

{
  "method": "tools/call",
  "params": {
    "name": "playbook_delete",
    "arguments": {
      "playbook_id": "00000000-0000-4000-8000-000000000001",
      "expected_revision": 1,
      "idempotency_key": "6f1c2a90-example-key"
    }
  }
}

Errors you may get

Code HTTP Retryable
unauthorized 401 No
key_expired 401 No
integration_revoked 401 No
connection_not_linked 403 No
integration_paused 403 No
workspace_integrations_paused 403 No
integration_authorization_lost 403 No
workspace_suspended 403 No
forbidden 403 No
invalid_input 422 No
rate_limited 429 Yes
internal 500 Yes
read_only 403 No
idempotency_key_required 428 No
idempotency_conflict 409 No
idempotency_processing 409 Yes
conflict 409 No
precondition_failed 422 No
revision_required 428 No
revision_conflict 412 No
not_found 404 No

Back to all operations