> ## Documentation Index
> Fetch the complete documentation index at: https://wordsmithai.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Check

> Change a check's name, instructions, severity or standard position.

> [!NOTE]
>
> **Preview.** This endpoint is available to organisations in the Wordsmith MCP pilot. Other organisations receive `403 mcp_not_enabled`. See the [preview overview](/preview).

Changes one [check](/proposed/objects#playbook-and-check) in a playbook. Send only the fields you want to change.

Reviews that start after this call use the new version. Findings from past reviews are not changed. Fallback positions cannot be changed through the API.

## Authentication

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

## Path parameters

**playbook\_id** `string` *required*

The playbook that holds the check.

**check\_id** `string` *required*

The check to change, from [Get Playbook](/api-reference/playbooks/get-playbook).

## Body parameters

**name** `string`

A short label, such as `Limitation of liability`, up to 200 characters.

**instructions** `string`

What the review should look for in the document. Not for a first-party check, whose instructions come from its positions.

**severity** `string`

`high`, `medium` or `low`.

**standard\_position** `string | null`

The position you want the document to take. Send `null` to clear it.

## Response

Returns `200` with the updated [check](/proposed/objects#playbook-and-check).

```bash cURL theme={null}
curl -X PATCH "https://api.wordsmith.ai/api/v1/playbooks/3804d3f1-ba8c-4d5e-97f7-c16466d0ece9/checks/e7d8a901-22b3-4c73-8362-0af4a7715c18" \
  -H "Authorization: Bearer sk-ws-api1-your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "standard_position": "Obligations last no more than 2 years after termination."
  }'
```

```json Response theme={null}
{
  "id": "e7d8a901-22b3-4c73-8362-0af4a7715c18",
  "name": "Term of confidentiality",
  "instructions": "Find how long the confidentiality obligations last after termination.",
  "severity": "high",
  "standard_position": "Obligations last no more than 2 years after termination.",
  "fallback_positions": []
}
```

## Errors

| Status | `error_code` | When |
| - | - | - |
| 400 | `invalid_request_body` | `name` or `instructions` is empty, or `severity` is not `high`, `medium` or `low`. |
| 400 | `check_instructions_not_editable` | `instructions` was sent for a first-party check. Its instructions come from its positions, which you change in Wordsmith. |
| 403 | `forbidden` | The caller can read the playbook but not edit it, or it is a global playbook. |
| 404 | `resource_not_found` | No playbook or check with these ids, or the caller cannot read the playbook. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.