Skip to main content

CreatePublicBookingIntentRequest

Request schema for creating a booking intent via a public interface.

account_idstringrequired

The account ID.

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
fields objectnullable

A map of custom field key-value pairs.

property name*anynullable

A map of custom field key-value pairs.

first_namestringnullable
last_namestringnullable
localestringnullable
phonestringnullable
reference_idstringnullable
time_zonestringnullable
end_atstring<date-time>nullable

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

provider_idstringnullable

The ID of the provider to assign.

service_idstringnullable

The ID of the service for this booking intent.

start_atstring<date-time>nullable

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.

  • 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).

    CreatePublicBookingIntentRequest
    {
    "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"
    }