Skip to content

Change a booking's location and/or conferencing

PATCH
/appointments/bookings/{booking_uid}/location

Change a booking’s physical location and/or its conferencing.

Two independent fields; send only the one you change. An omitted field is left as is, and null clears it:

  • selected_location: a location object, e.g. {"kind": "in_person_host", "address": "1 Market St"}, {"kind": "phone_host", "phone": "+14155550100"} or {"kind": "custom", "display_label": "Lobby"}.
  • selected_conferencing: {"kind": "link", "link": "https://..."} for a meeting URL, or {"kind": "conferencing", "provider": "zoom"} (also roam_auto, ms_teams, google_meet), which creates a NEW meeting room.
  • notify_attendees (default true): the host is always emailed.

The host’s calendar event is updated too; calendar_synced in the response is false when that update failed (the change is saved either way). Errors: 404 when the booking is not visible to the caller, 409 when it is cancelled, past, imported or changed meanwhile, 422 for an invalid value or a provider the host has not connected, 429 past the per-booking edit limit, 502 when a new meeting room could not be created (nothing is changed then).

Authorizations

Parameters

Path Parameters

booking_uid
required

Booking UID (uuid string).

string

Booking UID (uuid string).

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Change a booking’s location and/or conferencing.

Send only the field you change: an omitted field is left as is, and null clears it. selected_location is a physical, phone or custom location; selected_conferencing is a meeting link or a conferencing app (a new meeting room is created for zoom, roam_auto, ms_teams and google_meet). location is deprecated: a plain address, kept for older clients.

object
location
Any of:
string
notify_attendees
boolean
default: true
selected_conferencing
Any of:

A single location option on an event type.

object
address
Any of:
string
display_label
Any of:
string
kind
required

Rich location types for event types.

string
Allowed values: in_person_host in_person_attendee phone_host phone_attendee link conferencing custom
link
Any of:
string
phone
Any of:
string
provider
Any of:
string
public
boolean
default: true
selected_location
Any of:

A single location option on an event type.

object
address
Any of:
string
display_label
Any of:
string
kind
required

Rich location types for event types.

string
Allowed values: in_person_host in_person_attendee phone_host phone_attendee link conferencing custom
link
Any of:
string
phone
Any of:
string
provider
Any of:
string
public
boolean
default: true

Responses

200

Successful Response

object
key
additional properties
any

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string