Skip to main content
POST
Create or attach a user (idempotent via Idempotency-Key)

Authorizations

Authorization
string
header
required

Organization API key (org_…), sent as Authorization: Bearer <key>. Keys are scoped to one organization; every request operates within that tenant.

Body

application/json
email
string<email>
required
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
external_id
string
display_name
string
locale
string
first_name
string
last_name
string
country
string
Pattern: ^[A-Za-z]{2}$
dob
string
Pattern: ^\d{4}-\d{2}-\d{2}$

Response

Existing user/member returned unchanged

id
string
required
email
string
required
display_name
string | null
required
first_name
string | null
required
last_name
string | null
required
country
string | null
required
age_band
enum<string>
required
Available options:
under_13,
13_15,
16_17,
adult,
unknown
dob_verification_status
enum<string>
required
Available options:
unverified,
self_declared,
verified
last_active_at
string | null
required
status
enum<string>
required
Available options:
active,
locked,
deleted
wallet
object | null
required
membership
object
required