Appointments

Change a booking's location and/or conferencing

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).

patch/appointments/bookings/{booking_uid}/location

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/appointments/bookings/{booking_uid}/location
  • Auth: HTTP bearer

Path parameters

booking_uidstring required

Booking UID (uuid string).

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

notify_attendeesboolean
locationstring nullable

Response

Successful Response

object required

Changes

No recorded changes to this operation across all 2 revisions of this API.