Create Bookings in Bulk

This endpoint creates up to 50 bookings in one request.

Important Notes

  • Requires bookings:write scope.
  • Each booking accepts the fields of POST /v3/bookings and gets its defaults
    (creative_source = connect, the four send_* flags = false when omitted). Any other field
    of a booking, and any field of the body other than bookings, is dropped.
  • Connect only counts the bookings (at most 50). The shape of bookings and of each booking is
    checked by the bookings service, which answers the errors below.
  • All bookings must belong to locations of the company. The batch is all or nothing: if
    one booking fails, none is created and the error of the first failure is returned.
  • The request counts once against the rate limit, whatever the number of bookings.
  • The response lists the created bookings in data.
  • Each booking is independent (any clients); the embedded client of POST /v3/bookings is
    not available here.

Errors Dictionary

Every error of this operation has error and detail, also the ones of a single booking: they
are not the legacy keys of POST /v3/bookings.

StatusErrorDetailDescription
400invalid_bodyexpected_objectRequest body is not a JSON object.
400invalid_bodymalformedRequest body is not valid JSON.
400requiredbookingsbookings is missing, null or empty.
400invalid_formatbookingsbookings is not a list, or some item of it is not an object.
400requiredlocation_idNo booking carries a location_id.
401unauthorizedinvalid_api_keyMissing or invalid Bearer token.
401unauthorizedapi_config_inactiveAPI access is inactive for this company.
403forbiddenscope_deniedAPI key lacks bookings:write scope.
404not_foundlocationThe locations of the bookings belong to another company.
404not_foundbundleA bundle_id does not exist.
422max_bookings_exceededbookingsMore than 50 bookings in one request (Connect's limit).
422cross_companybookingsThe bookings span locations of more than one company.
422cross_locationbookingsBookings with a bundle_id belong to more than one location.
422restrictedpayment_statusThe company's payment status blocks booking creation.
4xx{error}{detail}The first booking that fails, with the error and detail of the bookings service (for example unavailable/provider, with reasons, or mismatch/provider_service). Nothing is created.
429rate_limitedburst_limit_exceededPer-minute request limit exceeded.
429rate_limiteddaily_quota_exceededDaily request quota exceeded.
502upstream_unavailableconnection_failedThe upstream service is unavailable.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Up to 50 bookings, each with the fields of CreateBookingRequest.

bookings
array of objects
required
length between 1 and 50
bookings*

Request body for creating a booking. Send client_id or client, never both.

client
object

The client of the booking, found or created as POST /v3/clients does with on_match: keep.
At least one of identification_number, email, phone is required.

date-time
required

Booking start time.

date-time

Booking end time. Calculated from start_time + service duration if not provided.

integer
required

Service ID.

integer
required

Service provider ID.

integer

Client ID. Required unless client is sent.

integer
required

Location ID.

integer

Booking status ID. Must be a non-cancelled status.

string

Booking price. Defaults to service price if not provided.

string | null

Booking notes.

string | null

Internal company note on the booking (free text). See createBooking.

string
length ≤ 128
^[A-Za-z0-9._~:-]{1,128}$

Your reference for the booking, stored in company_comment when valid (replacing the
company_comment of the same request) and ignored otherwise. See createBooking.

integer | null

Time resource ID. Required if the service requires a time resource.

boolean

Send the booking notification email to the client. false when omitted.

boolean

Send the booking notification to the client over WhatsApp. false when omitted.

boolean

Schedule the email reminder for this booking. false when omitted.

boolean

Schedule the WhatsApp reminder for this booking. false when omitted.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json