CreatePublicBookingIntentRequest
Request schema for creating a booking intent via a public interface.
The account ID.
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.
- ClientDataInput
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.
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.
The client's first name.
The client's last name.
The locale of the client booking the appointment.
en-USThe client's phone number (E.164 format).
+1234567890External reference identifier for the client.
The client's time zone (IANA format).
America/New_YorkThe end time of the slot as an ISO-8601 datetime string with a timezone offset.
The ID of the provider to assign.
The ID of the service for this booking intent.
The start time of the slot as an ISO-8601 datetime string with a timezone offset.
submissions object[]nullable
Form submissions to attach to this booking intent. Each entry contains a form_id and responses map.
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.
A map of response data keyed by field key. Values depend on field type.
{}The local time zone for the slot (IANA format).
{
"account_id": "acct_1234567890",
"end_at": "2026-02-23T10:30:00-05:00",
"service_id": "srv_1234567890",
"start_at": "2026-02-23T10:00:00-05:00",
"time_zone": "America/New_York"
}