Skip to main content
PATCH
Update an appointment

Authorizations

Authorization
string
header
required

API key passed as a Bearer token

Path Parameters

appointment_id
string
required

Body

application/json

PATCH body. Provide exactly one of status or scribeSessionId.

status is limited to cancelled / noshow (a booking is fulfilled only by the server when its session is created). scribeSessionId repairs a missed link: attach the session (ss_) whose id did not match the booking at create time; the booking then becomes fulfilled.

status
enum<string> | null

Set the booking to cancelled or noshow.

Available options:
cancelled,
noshow
Example:

"cancelled"

scribeSessionId
string | null

Public id of the session to attach when it was not auto-linked at create time. Sets the link and marks the booking fulfilled.

Pattern: ^ss_[a-z0-9]{16}$
Example:

"ss_a1b2c3d4e5f6g7h8"

Response

Successful Response

A single appointment. id is the stable public id (apt_...).

id
string
required

Stable public identifier.

Example:

"apt_a1b2c3d4e5f6g7h8"

status
string
required
Example:

"booked"

createdAt
string
required

ISO-8601 timestamp when the appointment was created.

consultationInternalId
string | null
Example:

"CONSULT-12345"

start
string | null
Example:

"2026-09-01T14:00:00.000Z"

end
string | null
Example:

"2026-09-01T14:30:00.000Z"

minutesDuration
integer | null
Example:

30

serviceType
string | null
Example:

"cardiology"

appointmentType
string | null
Example:

"follow-up"

reason
string | null
Example:

"Follow-up"

description
string | null
Example:

"Routine check"