Skip to main content
POST
Create patients

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
first_name
string
required
Maximum string length: 255
last_name
string | null
Maximum string length: 255
preferred_name
string | null
Maximum string length: 255
dob
string<date>
email
string<email>
Maximum string length: 255
sex
enum<string> | null
Available options:
male,
female,
other
note
string | null
custom_reference
string | null
Maximum string length: 255
locale
string | null
Maximum string length: 10
blocked
boolean
default_location
integer
referral_source_id
integer
referral_source_type
enum<string> | null
Available options:
referral_source,
patient
communication_preferences
object
numbers
object[]
address
object
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