CreateBookingLinkRequest

Request schema for creating a booking link

client_idstringnullable

The ID of a client to pre-select on the link.

Possible values: Value must match regular expression ^clnt_\w{12}$

expires_atdatetimenullable

When the link should stop accepting new bookings.

locked_fieldsstring[]

Fields the public booker may not change on begotten booking intents.

Possible values: [service_id, provider_id, slot, client_data, submissions]

max_usesintegernullable

How many confirmed bookings the link may beget. Omit for unlimited.

Possible values: >= 1

metadata object

property name*any

namestringnullable

An optional label for the link.

provider_idsstring[]

The provider subset the link is restricted to. Omit or pass an empty array to use the full service rotation.

Possible values: Value must match regular expression ^prov_\w{12}$

service_idstringrequired

The ID of the service to create the link on.

Possible values: Value must match regular expression ^srv_\w{12}$

CreateBookingLinkRequest

{
  "locked_fields": [
    "provider_id"
  ],
  "max_uses": 5,
  "name": "VIP onboarding",
  "provider_ids": [
    "prov_d025a96ac0c6"
  ],
  "service_id": "srv_d025a96ac0c6"
}