Skip to main content
POST
Create an appointment

Authorizations

X-API-Key
string
header
required

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

Body

application/json
patient_id
string
required

Patient ID (numeric)

Pattern: ^\d+$
Example:

"1743552000000"

appointment_type
string
required

Type of appointment

Example:

"Initial Evaluation"

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

"Telehealth"

start_at
string<date-time>
required

ISO 8601 datetime

Example:

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

duration_minutes
number
required

Duration in minutes

Required range: x >= 1
Example:

50

provider_id
string

Optional internal provider id (see GET /providers) to assign this appointment to. Must be a provider in your organization. Defaults to the provider that owns the API key.

Minimum string length: 1
Example:

"aaaaaaa1-0000-0000-0000-000000000001"

notes
string
Example:

"New patient intake. Please complete forms beforehand."

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

"SCHEDULED"

repeat_rule
object

Recurrence rule

external_id
string

Optional caller-supplied identifier. Unique per organization; immutable once set. Duplicate values return 409 with the existing record.

Required string length: 1 - 255
Example:

"PARTNER-APPT-789"

Response

Appointment created

data
object
required