Sign in

v1

latestOpenAPI 3.0.02026-07-17121287546.7 KB
Bookings / Guests

Add guests to an existing booking

Add one or more guests to an existing booking. Maximum 10 guests per request, with a limit of 30 total guests per booking.

**Rate Limiting:**
This endpoint is rate limited to 5 requests per minute to prevent abuse.

**Email Notifications:**
When guests are added, the following notifications are sent (unless disabled by event type settings):

- **Organizer & Team Members:** Receive an "Add Guests" notification email informing them that new guests have been added to the booking.

- **New Guests:** Receive a "Scheduled Event" email with full booking details and calendar invite. If they have a phone number, they also receive an SMS notification.

- **Existing Guests:** Receive an "Add Guests" notification email informing them that additional guests have been added to the booking.

<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}/guests

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

Example request

{
  "guests": [
    {
      "email": "john.doe@example.com",
      "name": "John Doe",
      "timeZone": "America/New_York"
    },
    {
      "email": "jane.smith@example.com",
      "name": "Jane Smith"
    }
  ]
}

Response

status'success' | 'error' required

Example response

{
  "status": "success",
  "data": {
    "id": 123,
    "uid": "booking_uid_123",
    "title": "Consultation",
    "description": "Learn how to integrate scheduling into marketplace.",
    "hosts": [
      {
        "id": 1,
        "name": "Jane Doe",
        "email": "jane100@example.com",
        "displayEmail": "jane100@example.com",
        "username": "jane100",
        "timeZone": "America/Los_Angeles"
      }
    ],
    "status": "accepted",
    "cancellationReason": "User requested cancellation",
    "cancelledByEmail": "canceller@example.com",
    "reschedulingReason": "User rescheduled the event",
    "rescheduledByEmail": "rescheduler@example.com",
    "rescheduledFromUid": "previous_uid_123",
    "rescheduledToUid": "new_uid_456",
    "start": "2024-08-13T15:30:00Z",
    "end": "2024-08-13T16:30:00Z",
    "duration": 60,
    "eventTypeId": 50,
    "eventType": {
      "id": 1,
      "slug": "some-event"
    },
    "meetingUrl": "https://example.com/recurring-meeting",
    "location": "https://example.com/meeting",
    "absentHost": true,
    "createdAt": "2024-08-13T15:30:00Z",
    "updatedAt": "2024-08-13T15:30:00Z",
    "metadata": {
      "key": "value"
    },
    "rating": 4,
    "icsUid": "ics_uid_123",
    "attendees": [
      {
        "name": "John Doe",
        "email": "john@example.com",
        "displayEmail": "john@example.com",
        "timeZone": "America/New_York",
        "language": "en",
        "phoneNumber": "+1234567890"
      }
    ],
    "guests": [
      "guest1@example.com",
      "guest2@example.com"
    ],
    "bookingFieldsResponses": {
      "customField": "customValue"
    }
  }
}