Skip to main content
POST
Create appointments

Authorizations

Authorization
string
header
required

API key from Developers → API Keys, sent as Authorization: Bearer .

Headers

Idempotency-Key
string

Any unique string (≤255 chars). A retry with the same key within 24 hours replays the original response (Idempotent-Replayed: true) instead of creating a second record.

Maximum string length: 255

Body

application/json
patient_id
integer
required
appointment_type_id
integer
required
location_id
integer
practitioner_id
integer
resource_id
integer
start
string<date-time>

Format Y-m-d H:i:s

end
string<date-time>

Format Y-m-d H:i:s

columns
integer
note
string | null
Maximum string length: 1000
status
enum<string>
Available options:
pending
cancel_note
string | null
Maximum string length: 1000
cancel_reason_id
integer
group_master_id
integer
allow_clash
boolean
metadata
object

Integrator-owned key/value metadata (max 50 keys). Values are strings (≤500 chars), numbers or booleans and read back with the type they were written with. On write, a null value removes the key. Filter with metadata[key]=op:value; number operands compare numerically.

Response

The resource

data
object