GCgc-ai
Playbooks

Update a check

Update a check's title, description, importance, or positions. At least one field is required. When positions is supplied it replaces the check's positions entirely.

Requires a user-scoped key with write access to the playbook. Org-scoped keys cannot update checks.

patch/playbooks/{id}/checks/{checkId}

Request

Path parameters

idstring uuid required

Playbook ID from GET /playbooks.

checkIdstring uuid required

Check ID from GET /playbooks/{id}/checks.

Request body

titlestring

New title (non-empty).

descriptionstring nullable

New description, or null to clear.

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

New priority, or null to clear.

Example request

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

Response

Updated check

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.