Playbook authoring
Update Check
Change a check’s name, instructions, severity or standard position.
PATCH
Preview. This endpoint is available to organisations in the Wordsmith MCP pilot. Other organisations receive
403 mcp_not_enabled. See the preview overview.Authentication
Requires an API key, or an OAuth token withplaybooks:write.
Path parameters
string
required
The playbook that holds the check.
string
required
The check to change, from Get Playbook.
Body parameters
string
A short label, such as
Limitation of liability, up to 200 characters.string
What the review should look for in the document. Not for a first-party check, whose instructions come from its positions.
string
high, medium or low.string | null
The position you want the document to take. Send
null to clear it.Response
Returns200 with the updated check.