UpdateBookingIntentRequest

Request schema for updating 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. Provided fields are merged with existing values.

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 if service is changing.

locked_fieldsstring[]nullable

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

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.

slot_prevalidatedbooleannullable

Whether the slot has been prevalidated. Automatically reset to false when slot-relevant fields (service_id, provider_id, start_at, end_at, time_zone) change, unless explicitly set to true in the same request.

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

UpdateBookingIntentRequest

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