Skip to main content
PATCH
Update a global alert
Only the fields you send change. Send "expiry_date": null to clear the expiry date.

Example Request

Example Response

You’ll receive global_alert.updated (same data as global_alert.created) or global_alert.update_failed. See Operation Events.

Authorizations

client_id
string
header
required
client_secret
string
header
required
access_token
string
header
required

Path Parameters

patient_id
string
required

Cobalt patient ID (id from the patient endpoints) or the patient MRN.

Example:

"12345"

emr_alert_id
string
required

EHR id of the alert on the chart: alerts.global_alerts[].emr_alert_id from POST /v1/patients/fetch.

Example:

"141004"

Body

application/json
notes
string

Free-text notes shown with the alert.

Example:

"Shoes arrived 11/18, pick up by 12/18"

expiry_date
string<date> | null

Expiry date (YYYY-MM-DD). The EHR stops showing the alert after this date. null clears it.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-12-31"

callback_urls
string[]

URLs to receive the completion webhook, in addition to the account webhook.

Example:
expires_at
string<date-time> | null

Optional ISO 8601 timestamp with an explicit timezone offset, in the future when submitted. Cobalt starts no new operation attempt after this deadline and reports reasons[].code EXPIRED. An attempt already in progress, including write reconciliation, may finish after it.

Example:

"2027-06-15T14:30:00Z"

Response

Global alert change queued for processing

success
boolean
required
Example:

true

message
string
required
Example:

"Global alert processing. A webhook event will be sent upon completion."

job_id
integer
required
Example:

12345