Skip to main content
PATCH
Complete or reopen an alert checklist item
Requires the alerts:write scope. Send the latest expectedRevision; stale revisions return 409 Conflict with the current revision. Use an Idempotency-Key header for completion or reopen requests that may be retried. The same item, action, and key return the existing result without duplicating comments or audit events. The complete action can include a comment and an evidence reference. Attachment evidence must belong to this checklist item. Automation evidence must reference a workflow execution for the parent alert.

Authorizations

Authorization
string
header
required

API key authentication. Use format: Bearer cbr_live_your_key

Headers

idempotency-key
string

Recommended for completion and reopen requests so retries do not duplicate side effects.

Required string length: 8 - 200

Path Parameters

id
string
required
Minimum string length: 1

Body

application/json
action
enum<string>
required
Available options:
complete
expectedRevision
integer
required
Required range: x >= 1
comment
string
Required string length: 1 - 20000
evidence
object

Response

Default Response

id
string
required
checklistId
string
required
source
enum<string>
required
Available options:
POLICY,
ALERT_SPECIFIC
sourcePolicyVersionId
string | null
required
stableKey
string
required
title
string
required
order
integer
required
required
boolean
required
requiresComment
boolean
required
evidenceRequirement
enum<string>
required
Available options:
NONE,
COMMENT,
ATTACHMENT,
AUTOMATION,
ANY
state
enum<string>
required
Available options:
PENDING,
IN_PROGRESS,
COMPLETED,
WAIVED
revision
integer
required
Required range: x >= 1
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
alertId
string
groupName
string | null
description
string | null
dependsOnStableKey
string | null
conditions
object | null
completedById
string | null
completedBy
AlertChecklistUser · object | null
completedAt
string<date-time> | null
waivedById
string | null
waivedBy
AlertChecklistUser · object | null
waivedAt
string<date-time> | null
waiverReason
string | null