Skip to main content

CreateClientRequest

Request schema for creating a client

emailstringrequired

The client's email address.

fields object

A map of custom field key-value pairs to set on this client.

property name*any

A map of custom field key-value pairs to set on this client.

first_namestringrequired

The client's first name.

last_namestringrequired

The client's last name.

localestring

The client's locale.

metadata object

Set of key-value pairs to attach to this client. Maximum size is 16 KB.

property name*any

Set of key-value pairs to attach to this client. Maximum size is 16 KB.

phonestring

The client's phone number (E.164 format).

reference_idstring

The client's external reference identifier.

time_zonestringrequired

The client's time zone (IANA format).

CreateClientRequest
{
"email": "john.smith@tendermedical.com",
"first_name": "John",
"last_name": "Smith",
"locale": "en",
"metadata": {
"external_id": "123"
},
"phone": "+15551234567",
"reference_id": "your-reference-id",
"time_zone": "America/New_York"
}