CompleteBookingIntentRequest

Request schema for completing a booking intent. Update fields (service_id, provider_id, etc.) may be provided inline and are applied atomically before completion.

auto_assign_providerbooleannullable

When true, automatically assigns an available provider for the selected time slot if no provider_id is specified.

client_data objectnullable

Progressive client data. Provided fields are merged with existing values.

anyOf

• ClientDataInput

emailemailnullable

The client's email address.

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.

last_namestringnullable

The client's last name.

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_zonestringnullable

The client's time zone (IANA format).

Example: America/New_York

client_idstringnullable

The ID of an existing client to link.

end_atdate-timenullable

The end time of the slot as an ISO-8601 datetime string with a timezone offset.

metadata objectnullable

Custom metadata key-value pairs. Replaces existing metadata entirely.

property name*anynullable

Custom metadata key-value pairs. Replaces existing metadata entirely.

provider_idstringnullable

The ID of the provider to assign.

service_idstringnullable

The ID of the service.

start_atdate-timenullable

The start time of the slot as an ISO-8601 datetime string with a timezone offset.

submissions object[]nullable

Form submissions to upsert by form_id. Provided entries are merged with existing submissions; omitted form_ids are left unchanged. Send an empty array to clear all.

Array [

form_idstringrequired

The ID of the form to submit responses for.

responses object

A map of response data keyed by field key. Values depend on field type.

property name*any

A map of response data keyed by field key. Values depend on field type.

Default value: {}

]

time_zonestringnullable

The local time zone for the slot (IANA format).

CompleteBookingIntentRequest

{
  "client_data": {
    "email": "jane@example.com",
    "first_name": "Jane"
  },
  "end_at": "2026-02-23T10:30:00-05:00",
  "provider_id": "prov_1234567890",
  "service_id": "srv_1234567890",
  "start_at": "2026-02-23T10:00:00-05:00",
  "time_zone": "America/New_York"
}