Przejdź do nawigacji
ReceptionLocations

Create Location

Add a new business location.

Nagłówki

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

Żądanie

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

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

customer_facing_namestringOpcjonalny

Name shown to customers; empty reuses name.

max_concurrent_appointmentsintegerOpcjonalny1-999Domyślnie 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_activebooleanOpcjonalnyDomyślnie true

Odpowiedź

Pomyślna odpowiedź

namestring
Internal name, e.g. 'Main Office' or 'Downtown Branch', shown in the dashboard and owner notifications.
_idstring
is_activebooleanTylko do odczytu
addressstringOpcjonalny
Street address.
notesstringOpcjonalny
Directions or other notes for customers, e.g. 'Free parking behind the building'.
operating_hoursobjectOpcjonalny
customer_facing_namestringOpcjonalny

Name shown to customers; empty reuses name.

max_concurrent_appointmentsintegerOpcjonalny1-999Domyślnie 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 nullOpcjonalny
Unix timestamp when this location was deactivated. None when active.
deactivation_reasonenum or nullOpcjonalny
Why this location was deactivated. None when active.
Dozwolone wartości:

Błędy

422
Unprocessable Entity Error