> ## Documentation Index
> Fetch the complete documentation index at: https://cal.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Update booking location for an existing booking
> Updates the booking location in Cal.com. For integration locations (e.g. Zoom, Google Meet, Cal Video), the endpoint also provisions a conference link and updates the corresponding calendar event via the organizer's connected credentials.
The cal-api-version header is required for this endpoint. Without it, the request will fail with a 404 error.
If accessed using an OAuth access token, the `BOOKING_WRITE` scope is required.
## OpenAPI
````yaml /api-reference/v2/openapi.json patch /v2/bookings/{bookingUid}/location
openapi: 3.0.0
info:
title: Cal.com API v2
description: ''
version: 1.0.0
contact: {}
servers: []
security: []
tags: []
paths:
/v2/bookings/{bookingUid}/location:
patch:
tags:
- Bookings
summary: Update booking location for an existing booking
description: >-
Updates the booking location in Cal.com. For integration locations (e.g.
Zoom, Google Meet, Cal Video), the endpoint also provisions a conference
link and updates the corresponding calendar event via the organizer's
connected credentials.
The cal-api-version header is required for this endpoint. Without it, the request will fail with a 404 error.
If accessed using an OAuth access token, the `BOOKING_WRITE` scope is
required.
operationId: BookingLocationController_2024_08_13_updateBookingLocation
parameters:
- name: cal-api-version
in: header
description: >-
Must be set to 2024-08-13. This header is required as this endpoint
does not exist in older API versions.
required: true
schema:
type: string
- name: bookingUid
required: true
in: path
schema:
type: string
- name: Authorization
in: header
description: >-
value must be `Bearer ` where `` is api key prefixed
with cal_, managed user access token, or OAuth access token
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateBookingLocationInput_2024_08_13'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateBookingLocationOutput_2024_08_13'
components:
schemas:
UpdateBookingLocationInput_2024_08_13:
type: object
properties:
location:
description: >-
One of the event type locations. If instead of passing one of the
location objects as required by schema you are still passing a
string please use an object.
oneOf:
- $ref: '#/components/schemas/UpdateInputAddressLocation_2024_08_13'
- $ref: >-
#/components/schemas/UpdateBookingInputAttendeeAddressLocation_2024_08_13
- $ref: >-
#/components/schemas/UpdateBookingInputAttendeeDefinedLocation_2024_08_13
- $ref: >-
#/components/schemas/UpdateBookingInputAttendeePhoneLocation_2024_08_13
- $ref: >-
#/components/schemas/UpdateBookingInputIntegrationLocation_2024_08_13
- $ref: '#/components/schemas/UpdateBookingInputLinkLocation_2024_08_13'
- $ref: '#/components/schemas/UpdateBookingInputPhoneLocation_2024_08_13'
UpdateBookingLocationOutput_2024_08_13:
type: object
properties:
status:
type: string
example: success
enum:
- success
- error
data:
oneOf:
- $ref: '#/components/schemas/BookingOutput_2024_08_13'
- $ref: '#/components/schemas/RecurringBookingOutput_2024_08_13'
- type: array
items:
$ref: '#/components/schemas/RecurringBookingOutput_2024_08_13'
- $ref: '#/components/schemas/GetSeatedBookingOutput_2024_08_13'
- $ref: '#/components/schemas/GetRecurringSeatedBookingOutput_2024_08_13'
- type: array
items:
$ref: >-
#/components/schemas/GetRecurringSeatedBookingOutput_2024_08_13
description: >-
Booking data, which can be either a BookingOutput object, a
RecurringBookingOutput object, or an array of RecurringBookingOutput
objects
required:
- status
- data
UpdateInputAddressLocation_2024_08_13:
type: object
properties:
type:
type: string
example: address
description: >-
only allowed value for type is `address` - it refers to address
defined by the organizer.
address:
type: string
example: 123 Example St, City, Country
required:
- type
- address
UpdateBookingInputAttendeeAddressLocation_2024_08_13:
type: object
properties:
type:
type: string
example: attendeeAddress
description: only allowed value for type is `attendeeAddress`
address:
type: string
example: 123 Example St, City, Country
required:
- type
- address
UpdateBookingInputAttendeeDefinedLocation_2024_08_13:
type: object
properties:
type:
type: string
example: attendeeDefined
description: only allowed value for type is `attendeeDefined`
location:
type: string
example: 321 Example St, City, Country
required:
- type
- location
UpdateBookingInputAttendeePhoneLocation_2024_08_13:
type: object
properties:
type:
type: string
example: attendeePhone
description: only allowed value for type is `attendeePhone`
phone:
type: string
example: '+37120993151'
required:
- type
- phone
UpdateBookingInputIntegrationLocation_2024_08_13:
type: object
properties:
type:
type: string
example: integration
description: only allowed value for type is `integration`
integration:
type: string
example: cal-video
enum:
- cal-video
- google-meet
- zoom
- whereby-video
- whatsapp-video
- webex-video
- telegram-video
- tandem
- sylaps-video
- skype-video
- sirius-video
- signal-video
- shimmer-video
- salesroom-video
- roam-video
- riverside-video
- ping-video
- office365-video
- mirotalk-video
- jitsi
- jelly-video
- jelly-conferencing
- huddle
- facetime-video
- element-call-video
- eightxeight-video
- discord-video
- demodesk-video
- campfire-video
required:
- type
- integration
UpdateBookingInputLinkLocation_2024_08_13:
type: object
properties:
type:
type: string
example: link
description: >-
only allowed value for type is `link` - it refers to link defined by
the organizer.
link:
type: string
example: https://meet.google.com/txi-fein-xyz
required:
- type
- link
UpdateBookingInputPhoneLocation_2024_08_13:
type: object
properties:
type:
type: string
example: phone
description: >-
only allowed value for type is `phone` - it refers to phone defined
by the organizer.
phone:
type: string
example: '+37120993151'
required:
- type
- phone
BookingOutput_2024_08_13:
type: object
properties:
id:
type: number
example: 123
uid:
type: string
example: booking_uid_123
title:
type: string
example: Consultation
description:
type: string
example: Learn how to integrate scheduling into marketplace.
hosts:
type: array
items:
$ref: '#/components/schemas/BookingHost'
status:
type: string
enum:
- cancelled
- accepted
- rejected
- pending
example: accepted
cancellationReason:
type: string
example: User requested cancellation
cancelledByEmail:
type: string
example: canceller@example.com
reschedulingReason:
type: string
example: User rescheduled the event
rescheduledByEmail:
type: string
example: rescheduler@example.com
rescheduledFromUid:
type: string
example: previous_uid_123
description: UID of the previous booking from which this booking was rescheduled.
rescheduledToUid:
type: string
example: new_uid_456
description: UID of the new booking to which this booking was rescheduled.
start:
type: string
example: '2024-08-13T15:30:00Z'
format: date-time
end:
type: string
example: '2024-08-13T16:30:00Z'
format: date-time
duration:
type: number
example: 60
eventTypeId:
type: number
example: 50
deprecated: true
description: Deprecated - rely on 'eventType' object containing the id instead.
eventType:
$ref: '#/components/schemas/EventType'
meetingUrl:
type: string
description: Deprecated - rely on 'location' field instead.
example: https://example.com/recurring-meeting
deprecated: true
location:
type: string
example: https://example.com/meeting
absentHost:
type: boolean
example: true
createdAt:
type: string
example: '2024-08-13T15:30:00Z'
format: date-time
updatedAt:
type: string
example: '2024-08-13T15:30:00Z'
format: date-time
metadata:
type: object
example:
key: value
rating:
type: number
example: 4
icsUid:
type: string
example: ics_uid_123
description: UID of ICS event.
attendees:
type: array
items:
$ref: '#/components/schemas/BookingAttendee'
guests:
example:
- guest1@example.com
- guest2@example.com
type: array
items:
type: string
bookingFieldsResponses:
type: object
description: >-
Booking field responses consisting of an object with booking field
slug as keys and user response as values.
example:
customField: customValue
required:
- id
- uid
- title
- description
- hosts
- status
- start
- end
- duration
- eventTypeId
- eventType
- location
- absentHost
- createdAt
- updatedAt
- attendees
- bookingFieldsResponses
RecurringBookingOutput_2024_08_13:
type: object
properties:
id:
type: number
example: 123
uid:
type: string
example: booking_uid_123
title:
type: string
example: Consultation
description:
type: string
example: Learn how to integrate scheduling into marketplace.
hosts:
type: array
items:
$ref: '#/components/schemas/BookingHost'
status:
type: string
enum:
- cancelled
- accepted
- rejected
- pending
example: accepted
cancellationReason:
type: string
example: User requested cancellation
cancelledByEmail:
type: string
example: canceller@example.com
reschedulingReason:
type: string
example: User rescheduled the event
rescheduledByEmail:
type: string
example: rescheduler@example.com
rescheduledFromUid:
type: string
example: previous_uid_123
description: UID of the previous booking from which this booking was rescheduled.
rescheduledToUid:
type: string
example: new_uid_456
description: UID of the new booking to which this booking was rescheduled.
start:
type: string
example: '2024-08-13T15:30:00Z'
format: date-time
end:
type: string
example: '2024-08-13T16:30:00Z'
format: date-time
duration:
type: number
example: 60
eventTypeId:
type: number
example: 50
deprecated: true
description: Deprecated - rely on 'eventType' object containing the id instead.
eventType:
$ref: '#/components/schemas/EventType'
meetingUrl:
type: string
description: Deprecated - rely on 'location' field instead.
example: https://example.com/recurring-meeting
deprecated: true
location:
type: string
example: https://example.com/meeting
absentHost:
type: boolean
example: true
createdAt:
type: string
example: '2024-08-13T15:30:00Z'
format: date-time
updatedAt:
type: string
example: '2024-08-13T15:30:00Z'
format: date-time
metadata:
type: object
example:
key: value
rating:
type: number
example: 4
icsUid:
type: string
example: ics_uid_123
description: UID of ICS event.
attendees:
type: array
items:
$ref: '#/components/schemas/BookingAttendee'
guests:
example:
- guest1@example.com
- guest2@example.com
type: array
items:
type: string
bookingFieldsResponses:
type: object
description: >-
Booking field responses consisting of an object with booking field
slug as keys and user response as values.
example:
customField: customValue
recurringBookingUid:
type: string
example: recurring_uid_987
required:
- id
- uid
- title
- description
- hosts
- status
- start
- end
- duration
- eventTypeId
- eventType
- location
- absentHost
- createdAt
- updatedAt
- attendees
- bookingFieldsResponses
- recurringBookingUid
GetSeatedBookingOutput_2024_08_13:
type: object
properties:
id:
type: number
example: 123
uid:
type: string
example: booking_uid_123
title:
type: string
example: Consultation
description:
type: string
example: Learn how to integrate scheduling into marketplace.
hosts:
type: array
items:
$ref: '#/components/schemas/BookingHost'
status:
type: string
enum:
- cancelled
- accepted
- rejected
- pending
example: accepted
cancellationReason:
type: string
example: User requested cancellation
cancelledByEmail:
type: string
example: canceller@example.com
reschedulingReason:
type: string
example: User rescheduled the event
rescheduledByEmail:
type: string
example: rescheduler@example.com
rescheduledFromUid:
type: string
example: previous_uid_123
description: UID of the previous booking from which this booking was rescheduled.
rescheduledToUid:
type: string
example: new_uid_456
description: UID of the new booking to which this booking was rescheduled.
start:
type: string
example: '2024-08-13T15:30:00Z'
format: date-time
end:
type: string
example: '2024-08-13T16:30:00Z'
format: date-time
duration:
type: number
example: 60
eventTypeId:
type: number
example: 50
deprecated: true
description: Deprecated - rely on 'eventType' object containing the id instead.
eventType:
$ref: '#/components/schemas/EventType'
meetingUrl:
type: string
description: Deprecated - rely on 'location' field instead.
example: https://example.com/recurring-meeting
deprecated: true
location:
type: string
example: https://example.com/meeting
absentHost:
type: boolean
example: true
createdAt:
type: string
example: '2024-08-13T15:30:00Z'
format: date-time
updatedAt:
type: string
example: '2024-08-13T15:30:00Z'
format: date-time
metadata:
type: object
example:
key: value
rating:
type: number
example: 4
icsUid:
type: string
example: ics_uid_123
description: UID of ICS event.
attendees:
type: array
items:
$ref: '#/components/schemas/SeatedAttendee'
required:
- id
- uid
- title
- description
- hosts
- status
- start
- end
- duration
- eventTypeId
- eventType
- location
- absentHost
- createdAt
- updatedAt
- attendees
GetRecurringSeatedBookingOutput_2024_08_13:
type: object
properties:
id:
type: number
example: 123
uid:
type: string
example: booking_uid_123
title:
type: string
example: Consultation
description:
type: string
example: Learn how to integrate scheduling into marketplace.
hosts:
type: array
items:
$ref: '#/components/schemas/BookingHost'
status:
type: string
enum:
- cancelled
- accepted
- rejected
- pending
example: accepted
cancellationReason:
type: string
example: User requested cancellation
cancelledByEmail:
type: string
example: canceller@example.com
reschedulingReason:
type: string
example: User rescheduled the event
rescheduledByEmail:
type: string
example: rescheduler@example.com
rescheduledFromUid:
type: string
example: previous_uid_123
description: UID of the previous booking from which this booking was rescheduled.
rescheduledToUid:
type: string
example: new_uid_456
description: UID of the new booking to which this booking was rescheduled.
start:
type: string
example: '2024-08-13T15:30:00Z'
format: date-time
end:
type: string
example: '2024-08-13T16:30:00Z'
format: date-time
duration:
type: number
example: 60
eventTypeId:
type: number
example: 50
deprecated: true
description: Deprecated - rely on 'eventType' object containing the id instead.
eventType:
$ref: '#/components/schemas/EventType'
meetingUrl:
type: string
description: Deprecated - rely on 'location' field instead.
example: https://example.com/recurring-meeting
deprecated: true
location:
type: string
example: https://example.com/meeting
absentHost:
type: boolean
example: true
createdAt:
type: string
example: '2024-08-13T15:30:00Z'
format: date-time
updatedAt:
type: string
example: '2024-08-13T15:30:00Z'
format: date-time
metadata:
type: object
example:
key: value
rating:
type: number
example: 4
icsUid:
type: string
example: ics_uid_123
description: UID of ICS event.
attendees:
type: array
items:
$ref: '#/components/schemas/SeatedAttendee'
recurringBookingUid:
type: string
example: recurring_uid_987
required:
- id
- uid
- title
- description
- hosts
- status
- start
- end
- duration
- eventTypeId
- eventType
- location
- absentHost
- createdAt
- updatedAt
- attendees
- recurringBookingUid
BookingHost:
type: object
properties:
id:
type: number
example: 1
name:
type: string
example: Jane Doe
email:
type: string
example: jane100@example.com
displayEmail:
type: string
example: jane100@example.com
description: Clean email for display purposes
username:
type: string
example: jane100
timeZone:
type: string
example: America/Los_Angeles
required:
- id
- name
- email
- displayEmail
- username
- timeZone
EventType:
type: object
properties:
id:
type: number
example: 1
slug:
type: string
example: some-event
required:
- id
- slug
BookingAttendee:
type: object
properties:
name:
type: string
example: John Doe
email:
type: string
example: john@example.com
displayEmail:
type: string
example: john@example.com
description: Clean email for display purposes
timeZone:
type: string
example: America/New_York
language:
enum:
- 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
type: string
example: en
absent:
type: boolean
example: false
phoneNumber:
type: string
example: '+1234567890'
required:
- name
- email
- displayEmail
- timeZone
- absent
SeatedAttendee:
type: object
properties:
name:
type: string
example: John Doe
email:
type: string
example: john@example.com
displayEmail:
type: string
example: john@example.com
description: Clean email for display purposes
timeZone:
type: string
example: America/New_York
language:
enum:
- 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
type: string
example: en
absent:
type: boolean
example: false
phoneNumber:
type: string
example: '+1234567890'
seatUid:
type: string
example: 3be561a9-31f1-4b8e-aefc-9d9a085f0dd1
createdAt:
type: string
example: '2024-08-13T15:30:00Z'
description: The date and time when the attendee joined the seated booking.
bookingFieldsResponses:
type: object
description: >-
Booking field responses consisting of an object with booking field
slug as keys and user response as values.
example:
customField: customValue
metadata:
type: object
example:
key: value
required:
- name
- email
- displayEmail
- timeZone
- absent
- seatUid
- bookingFieldsResponses
````