Skip to main content

CompletePublicBookingIntentRequest

Request schema for completing a booking intent via a public interface. Update fields 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.

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.

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

    CompletePublicBookingIntentRequest
    {
    "client_data": {
    "email": "jane@example.com",
    "first_name": "Jane"
    },
    "service_id": "srv_1234567890"
    }