Skip to main content
PATCH
/
playbooks
/
{id}
/
checks
/
{checkId}
Update a check
curl --request PATCH \
  --url https://app.gc.ai/api/external/v1/playbooks/{id}/checks/{checkId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "positions": [
    {
      "guidance": "Require a mutual liability cap at 12 months of fees."
    }
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "description": "<string>",
  "positions": [
    {
      "guidance": "<string>"
    }
  ],
  "created_at": "<string>",
  "updated_at": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Format: gcai_xxxxxxxxx

Create API keys in the GC AI app under Settings → API.

Path Parameters

​
id
string<uuid>
required

Playbook ID from GET /playbooks.

​
checkId
string<uuid>
required

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

Body

application/json
​
title
string

New title (non-empty).

Minimum string length: 1
​
description
string | null

New description, or null to clear.

​
importance
enum<string> | null

New priority, or null to clear.

Available options:
low,
medium,
high,
null
​
positions
object[]

Replacement set of positions (full desired state). Omit to leave positions unchanged.

Minimum array length: 1

Response

Updated check

​
id
string<uuid>
required

Unique check identifier

​
title
string
required

Check title

​
description
string | null
required

Optional internal description, or null if unset

​
importance
enum<string> | null
required

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

Available options:
low,
medium,
high,
null
​
positions
object[]
required

The check's positions: one standard stance plus any fallbacks.

​
created_at
string | null
required

ISO 8601 creation timestamp

​
updated_at
string | null
required

ISO 8601 last-update timestamp