Zur Navigation springen
ReceptionLocations

Create Location

Add a new business location.

Header

xi-api-keystringOptional
xi-workspace-idstring or nullOptional
The customer workspace a reseller's API key acts on.

Anfrage

This endpoint expects an object.
namestringErforderlich
Internal name, e.g. 'Main Office' or 'Downtown Branch', shown in the dashboard and owner notifications.
addressstringOptional
Street address.
notesstringOptional
Directions or other notes for customers, e.g. 'Free parking behind the building'.
operating_hoursobject or nullOptional

Per-location operating hours. On create, omit to have the server prefill from the most recently added active location.

customer_facing_namestringOptional

Name shown to customers; empty reuses name.

max_concurrent_appointmentsintegerOptional1-999Standardwert ist 1

Maximum number of appointments that may overlap at this location at a single instant. Only enforced while the booking page setting concurrent_limit_enabled is on.

is_activebooleanOptionalStandardwert ist true

Antwort

Erfolgreiche Antwort
namestring
Internal name, e.g. 'Main Office' or 'Downtown Branch', shown in the dashboard and owner notifications.
_idstring
is_activebooleanSchreibgeschützt
addressstringOptional
Street address.
notesstringOptional
Directions or other notes for customers, e.g. 'Free parking behind the building'.
operating_hoursobjectOptional
customer_facing_namestringOptional

Name shown to customers; empty reuses name.

max_concurrent_appointmentsintegerOptional1-999Standardwert ist 1

Maximum number of appointments that may overlap at this location at a single instant. Only enforced while the booking page setting concurrent_limit_enabled is on.

deactivated_at_unixinteger or nullOptional
Unix timestamp when this location was deactivated. None when active.
deactivation_reasonenum or nullOptional
Why this location was deactivated. None when active.
Erlaubte Werte:

Fehler

422
Unprocessable Entity Error