Skip to main content
POST
Create a recall
Recalls are created asynchronously: a valid request returns immediately, and a recall.created or recall.failed webhook is sent when processing completes.

Authorizations

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

Body

application/json
patient_mrn
string
required

MRN of the patient the recall is for.

Example:

"12345"

recall_type
string
required

Exact recall type name as configured in the EMR.

Example:

"Inbound Referral 1 Week"

due_date
string
required

Target due date (YYYY-MM-DD).

Example:

"2026-09-01"

provider_ehr_id
string

EMR provider id for the recall. Supply this or provider_name (id preferred).

Example:

"provider-123"

provider_name
string

Provider name as synced. Used only when provider_ehr_id is absent.

Example:

"Dr. Alex Smith"

reason
string

Free-text reason for the recall (ModMed EMA: max 100 characters).

Example:

"Specialist consultation"

appt_notes
string

Initial note on the recall (ModMed EMA: max 255 characters).

Example:

"Call patient to schedule follow-up."

callback_urls
string[]

URLs to receive the completion webhook for this create.

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 create 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