Skip to main content
POST
Add an action to a recall
Actions are added asynchronously: a valid request returns immediately, and a recall_action.created or recall_action.failed webhook is sent when processing completes.

Authorizations

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

Path Parameters

id
string
required
Example:

"recall-abc-123"

Body

application/json
action_taken
string
required

Exact activity type label to log (e.g. "Phone Call", "Closed - Other"). A "Closed - *" type closes the recall.

Example:

"Phone Call"

note
string

Optional activity note (max 255 characters).

Example:

"Called patient to arrange follow-up."

callback_urls
string[]

URLs to receive the completion webhook for this action.

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

Recall action queued for processing

success
boolean
required
Example:

true

message
string
required
Example:

"Request processed."

recall_id
string
required
Example:

"recall-abc-123"

job_id
integer
required
Example:

1