Playbooks

Add a check to a playbook

Create a check and append it to the playbook.

Requires write access to the playbook. With a user-scoped key the caller is recorded as the check’s creator; with an org-scoped key the check has no individual creator and is org-owned.

post/playbooks/{id}/checks

Request

Path parameters

idstring uuid required

Playbook ID from GET /playbooks.

Request body

titlestring required

Check title (required, non-empty).

descriptionstring nullable

Optional internal description.

importance'low' | 'medium' | 'high' | 'null' nullable

Optional priority within the playbook.

Example request

{
  "title": "Limitation of liability",
  "positions": [
    {
      "guidance": "Require a mutual liability cap at 12 months of fees."
    }
  ]
}

Response

Check created

idstring uuid required

Unique check identifier

titlestring required

Check title

descriptionstring nullable required

Optional internal description, or null if unset

importance'low' | 'medium' | 'high' | 'null' nullable required

Priority of this check within the playbook, or null if unset

created_atstring nullable required

ISO 8601 creation timestamp

updated_atstring nullable required

ISO 8601 last-update timestamp

Changes

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