AppointmentClientDataInput

Information about the client booking the appointment. You can either provide an id or reference_id for an existing client, or provide a new client's details.

emailemailnullable

The client's email address. Required if no existing client is provided.

fields objectnullable

A map of custom field values to set on the client, keyed by field slug. Each key must correspond to a Client Field that has been defined in the account; arbitrary key-value pairs are not accepted.

property name*anynullable

A map of custom field values to set on the client, keyed by field slug. Each key must correspond to a Client Field that has been defined in the account; arbitrary key-value pairs are not accepted.

first_namestringnullable

The client's first name. Required if no existing client is provided.

idstringnullable

The ID of an existing client to attach to the appointment. If not provided, a new client will be created if the reference_id does not correspond to an existing client. If there does exist a client with the reference_id provided, the existing client will be attached to the appointment.

last_namestringnullable

The client's last name. Required if no existing client is provided.

localestringnullable

The locale of the client booking the appointment.

Example: en-US

phonestringnullable

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

Example: +1234567890

reference_idstringnullable

External reference identifier for the client.

time_zonestringrequired

The client's time zone (IANA format). This field will be used to represent the appointment time slot in the client's local time zone (in the event that it differs from the appointment's local time zone).

Example: America/New_York

AppointmentClientDataInput

{
  "email": "john.doe@example.com",
  "fields": {
    "age": 30
  },
  "first_name": "John",
  "last_name": "Doe",
  "locale": "en-US",
  "phone": "+15551234567",
  "reference_id": "1234567890",
  "time_zone": "America/New_York"
}