Skip to main content
POST
Add guests to an existing booking

Headers

cal-api-version
string
required

Must be set to 2024-08-13. This header is required as this endpoint does not exist in older API versions.

Example:

"2024-08-13"

Authorization
string
required

value must be Bearer <token> where <token> is api key prefixed with cal_, managed user access token, or OAuth access token

Path Parameters

bookingUid
string
required

Body

application/json
guests
object[]

Array of guests to add to the booking. Maximum 100 guests per request. Required unless contactIds or contactTagIds is given.

Example:
contactIds
string<uuid>[]

Ids of the authenticated user's own contacts, from GET /v2/contacts. Each contact is added at its email and with its name, and they count with guests and contactTagIds toward the 100 guests a booking can have, once per email. Requires the contacts feature. A contact the user doesn't own is a 400.

Required array length: 1 - 100 elements
Example:
contactTagIds
string<uuid>[]

Ids of the authenticated user's own contact tags, from the tags of each contact in GET /v2/contacts. Every contact with one of these tags is added, and they count with guests and contactIds toward the 100 guests a booking can have, once per email. Tags that don't fit are refused whole. Requires the contacts feature. A tag the user doesn't own is a 400.

Required array length: 1 - 20 elements
Example:

Response

200 - application/json
status
enum<string>
required
Available options:
success,
error
Example:

"success"

data
Booking · object
required

Booking data, which can be either a BookingOutput object, a RecurringBookingOutput object, or an array of RecurringBookingOutput objects