Skip to main content
POST
Updates the status of a visit

Authorizations

Authorization
string
header
required

Authorization: Bearer <api_token>. Sandbox tokens come from Get API keys and allow 2,000 successful requests or 7 days. Failed 4xx/5xx responses do not consume the allowance. Production tokens are issued from the group's API access tab.

Body

application/json
accession_id
string
required

Visit reference ID (accession number)

status
enum<string>
required

Status to update. appointment_received: marks visit as booked, no_show: marks visit as no show

Available options:
appointment_received,
no_show
start_time
string<date-time>

Appointment start time (required for appointment_received status)

Response

status updated successfully

success
boolean
required

Status update result