Skip to main content
PATCH
Update a recall

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
status
string

New recall status.

Example:

"OPEN"

status_note
string

Optional note recorded alongside a status change.

Example:

"Patient requested a follow-up call."

note
string

Note text to add to the recall.

Example:

"Called patient to arrange follow-up."

note_type
string

Category for the added note.

Example:

"General"

callback_urls
string[]

URLs to receive the completion webhook for this update.

Example:

Response

Recall update 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