Skip to main content
PATCH
Update an appointment

Authorizations

X-API-Key
string
header
required

API key obtained from /api/v1/ext-api-keys

Path Parameters

appointmentId
string
required

Appointment UUID

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

Body

application/json
patient_id
string

Patient ID (numeric)

Pattern: ^\d+$
Example:

"1743552000000"

provider_id
string

Reassign this appointment to a different provider (see GET /providers). Must be a provider in your organization.

Minimum string length: 1
Example:

"aaaaaaa1-0000-0000-0000-000000000001"

appointment_type
string
Example:

"Follow-up"

visit_type
enum<string>
Available options:
Telehealth,
In-Person,
Both,
Other
Example:

"In-Person"

start_at
string<date-time>

ISO 8601 datetime

Example:

"2026-04-15T14:00:00.000Z"

duration_minutes
number
Required range: x >= 1
Example:

50

notes
string
Example:

"Updated notes"

status
enum<string>
Available options:
SCHEDULED,
COMPLETED,
CANCELLED,
NO_SHOW
Example:

"COMPLETED"

Response

Appointment updated

data
object
required