Hoppa till navigering
ReceptionLocations

Create Location

Add a new business location.

Headers

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

Förfrågan

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

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

customer_facing_namestringValfri

Name shown to customers; empty reuses name.

max_concurrent_appointmentsintegerValfri1-999Standard är 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_activebooleanValfriStandard är true

Svar

Lyckat svar
namestring
Internal name, e.g. 'Main Office' or 'Downtown Branch', shown in the dashboard and owner notifications.
_idstring
is_activebooleanSkrivskyddad
addressstringValfri
Street address.
notesstringValfri
Directions or other notes for customers, e.g. 'Free parking behind the building'.
operating_hoursobjectValfri
customer_facing_namestringValfri

Name shown to customers; empty reuses name.

max_concurrent_appointmentsintegerValfri1-999Standard är 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 nullValfri
Unix timestamp when this location was deactivated. None when active.
deactivation_reasonenum or nullValfri
Why this location was deactivated. None when active.
Tillåtna värden:

Fel

422
Unprocessable Entity Error