Skip to main content
POST
Preview. This endpoint is available to organisations in the Wordsmith MCP pilot. Other organisations receive 403 mcp_not_enabled. See the preview overview.
Adds one check to a playbook. A check tells a review what to look for and which position you want the document to take. The new check goes to the end of the list, so reviews run it last. Reviews that start after this call run the new check. Reviews already running or finished are not changed. Fallback positions cannot be written through the API: fallback_positions comes back empty for a check you add. Negotiation playbooks built in the Wordsmith app keep their fallbacks, and Get Playbook returns them.

Authentication

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

Path parameters

string
required
The playbook to add the check to.

Body parameters

string
required
A short label, such as Limitation of liability, up to 200 characters. Findings show it as check.name.
string
required
What the review should look for in the document.
string
default:"medium"
high, medium or low. Sets the severity of a finding when the document misses the position.
string
The position you want the document to take.

Response

Returns 201 with the new check.

Errors