Playbooks

Delete a playbook

Soft-delete a playbook by ID. The playbook is marked as deleted and will no longer appear in GET /playbooks results.

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

delete/playbooks/{id}

Request

Base URL
https://app.gc.ai/api/external/v1
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/gc-ai/apis/gc-ai-external-api/docs/playbooks/:id/delete.ts
A function with typed inputs. Its response is checked against the schema.

idstring uuid required

The playbook ID to delete

Playbook successfully deleted

deletedboolean required

Always true on success

No recorded changes to this operation across all 1 revision of this API.