Sign in

v1

latestOpenAPI 3.0.02026-07-17121287546.7 KB
Bookings / Attendees

Add an attendee to a booking

Add a new attendee to an existing booking by its UID.

  **Side effects:**
  - The booking's attendee list is updated in the database
  - The calendar event is updated on connected calendars (Google Calendar, Outlook, etc.) to include the new attendee
  - An email notification is sent to the new attendee with the booking details

  **Permissions:**
  - The authenticated user must be either the booking organizer, an existing attendee, or have the `booking.update` permission for the team

  <Note>The cal-api-version header is required for this endpoint. Without it, the request will fail with a 404 error.</Note>
post/v2/bookings/{bookingUid}/attendees

Path parameters

bookingUidstring required

Headers

cal-api-versionstring required

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

Authorizationstring required

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

Request body

namestring required

The name of the attendee.

timeZonestring required

The time zone of the attendee.

phoneNumberstring

The phone number of the attendee in international format.

language'ar' | 'ca' | 'de' | 'es' | 'eu' | 'he' | 'id' | 'ja' | 'lv' | 'pl' | 'ro' | 'sr' | 'th' | 'vi' | 'az' | 'cs' | 'el' | 'es-419' | 'fi' | 'hr' | 'it' | 'km' | 'nl' | 'pt' | 'ru' | 'sv' | 'tr' | 'zh-CN' | 'bg' | 'da' | 'en' | 'et' | 'fr' | 'hu' | 'iw' | 'ko' | 'no' | 'pt-BR' | 'sk' | 'ta' | 'uk' | 'zh-TW' | 'bn'

The preferred language of the attendee. Used for booking confirmation.

emailstring required

The email of the attendee.

Example request

{
  "name": "John Doe",
  "timeZone": "America/New_York",
  "phoneNumber": "+919876543210",
  "language": "it",
  "email": "john.doe@example.com"
}

Response

status'success' | 'error' required

Example response

{
  "status": "success",
  "data": {
    "name": "John Doe",
    "email": "john@example.com",
    "displayEmail": "john@example.com",
    "timeZone": "America/New_York",
    "language": "en",
    "phoneNumber": "+1234567890",
    "id": 251,
    "bookingId": 313
  }
}