Bookings

Update booking location for an existing booking

Updates the location for an existing booking.

Integration Fallback Behavior:

  • Google Meet: Requires Google Calendar to be connected. If the booking has no Google Calendar event, it will automatically fall back to Cal Video.
  • MS Teams: If Office 365 Calendar is connected, generates the meeting link via calendar. Otherwise, uses the MS Teams video integration directly.

<Note>The cal-api-version header is required for this endpoint. Without it, the request will fail with a 404 error.</Note>

patch/v2/bookings/{bookingUid}/location

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

{
  "location": {
    "type": "address",
    "address": "123 Example St, City, Country"
  }
}

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"
    }
  }
}

Changes

Changed in 5 of the 50 revisions of this API.2011

    • added UpdateBookingInputIntegrationLocation_2024_08_13 to the location request property oneOf list

      request-property-one-of-added

    • added the new required request property location/oneOf[UpdateBookingInputAttendeeAddressLocation_2024_08_13]/address

      new-required-request-property

    • added the new required request property location/oneOf[UpdateBookingInputAttendeeAddressLocation_2024_08_13]/type

      new-required-request-property

    • added the new required request property location/oneOf[UpdateBookingInputAttendeeDefinedLocation_2024_08_13]/location

      new-required-request-property

    • added the new required request property location/oneOf[UpdateBookingInputAttendeeDefinedLocation_2024_08_13]/type

      new-required-request-property

    • added the new required request property location/oneOf[UpdateBookingInputAttendeePhoneLocation_2024_08_13]/phone

      new-required-request-property

    • added the new required request property location/oneOf[UpdateBookingInputAttendeePhoneLocation_2024_08_13]/type

      new-required-request-property

    • added the new required request property location/oneOf[UpdateBookingInputLinkLocation_2024_08_13]/link

      new-required-request-property

    • added the new required request property location/oneOf[UpdateBookingInputLinkLocation_2024_08_13]/type

      new-required-request-property

    • added the new required request property location/oneOf[UpdateBookingInputPhoneLocation_2024_08_13]/phone

      new-required-request-property

    • added the new required request property location/oneOf[UpdateBookingInputPhoneLocation_2024_08_13]/type

      new-required-request-property

    • added the new required request property location/oneOf[UpdateInputAddressLocation_2024_08_13]/address

      new-required-request-property

    • added the new required request property location/oneOf[UpdateInputAddressLocation_2024_08_13]/type

      new-required-request-property

    • the location/oneOf[UpdateBookingInputAttendeeAddressLocation_2024_08_13]/ request property type/format changed from / to object/

      request-property-type-changed

    • the location/oneOf[UpdateBookingInputAttendeeDefinedLocation_2024_08_13]/ request property type/format changed from / to object/

      request-property-type-changed

    • the location/oneOf[UpdateBookingInputAttendeePhoneLocation_2024_08_13]/ request property type/format changed from / to object/

      request-property-type-changed

    • the location/oneOf[UpdateBookingInputLinkLocation_2024_08_13]/ request property type/format changed from / to object/

      request-property-type-changed

    • the location/oneOf[UpdateBookingInputPhoneLocation_2024_08_13]/ request property type/format changed from / to object/

      request-property-type-changed

    • the location/oneOf[UpdateInputAddressLocation_2024_08_13]/ request property type/format changed from / to object/

      request-property-type-changed

  • v2a3b94595a3bd19See the full diff
    • added subschema #3 subschema #6 to the data response property oneOf list for the response status 200

      response-property-one-of-added

    • removed subschema #3 subschema #6 from the data response property oneOf list for the response status 200

      response-property-one-of-removed

    • added the required property data/oneOf[BookingOutput_2024_08_13]/attendees/items/displayEmail to the response with the 200 status

      response-required-property-added

    • added the required property data/oneOf[BookingOutput_2024_08_13]/hosts/items/displayEmail to the response with the 200 status

      response-required-property-added

    • added the required property data/oneOf[GetRecurringSeatedBookingOutput_2024_08_13]/attendees/items/displayEmail to the response with the 200 status

      response-required-property-added

    • added the required property data/oneOf[GetRecurringSeatedBookingOutput_2024_08_13]/hosts/items/displayEmail to the response with the 200 status

      response-required-property-added

    • added the required property data/oneOf[GetSeatedBookingOutput_2024_08_13]/attendees/items/displayEmail to the response with the 200 status

      response-required-property-added

    • added the required property data/oneOf[GetSeatedBookingOutput_2024_08_13]/hosts/items/displayEmail to the response with the 200 status

      response-required-property-added

    • added the required property data/oneOf[RecurringBookingOutput_2024_08_13]/attendees/items/displayEmail to the response with the 200 status

      response-required-property-added

    • added the required property data/oneOf[RecurringBookingOutput_2024_08_13]/hosts/items/displayEmail to the response with the 200 status

      response-required-property-added

    • endpoint added

      endpoint-added

    • api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 46 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog