CreateBookingIntentRequest

Request schema for creating a booking intent

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 to collect during the booking flow.

emailstringnullable

first_namestringnullable

last_namestringnullable

localestringnullable

phonestringnullable

reference_idstringnullable

time_zonestringnullable

client_idstringnullable

The ID of an existing client to link.

end_atstring<date-time>nullable

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

hold_durationstringnullable

The hold duration as an ISO 8601 duration string (e.g., PT10M). When omitted, falls back to the service's hold policy duration.

hold_enabledbooleannullable

Whether to enable slot holding. When omitted, falls back to the service's hold policy.

locked_fieldsstring[]nullable

Fields to lock from public API updates. Possible values: service_id, provider_id, start_at, end_at, time_zone, client_data.

metadata objectnullable

Custom metadata key-value pairs.

property name*anynullable

Custom metadata key-value pairs.

provider_idstringnullable

The ID of the provider to assign.

service_idstringnullable

The ID of the service for this booking intent.

slot_prevalidatedboolean

Whether the slot has been prevalidated. When true, public completion skips slot validation.

Default value: false

start_atstring<date-time>nullable

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

time_zonestringnullable

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

CreateBookingIntentRequest

{
  "hold_duration": "PT10M",
  "hold_enabled": true,
  "metadata": {
    "source": "web"
  },
  "service_id": "srv_1234567890"
}