Saltar a la navegación
ReceptionLocations

Create Location

Add a new business location.

Encabezados

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

Solicitud

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

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

customer_facing_namestringOpcional

Name shown to customers; empty reuses name.

max_concurrent_appointmentsintegerOpcional1-999Valor predeterminado: 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_activebooleanOpcionalValor predeterminado: true

Respuesta

Respuesta correcta.
namestring
Internal name, e.g. 'Main Office' or 'Downtown Branch', shown in the dashboard and owner notifications.
_idstring
is_activebooleanSolo lectura
addressstringOpcional
Street address.
notesstringOpcional
Directions or other notes for customers, e.g. 'Free parking behind the building'.
operating_hoursobjectOpcional
customer_facing_namestringOpcional

Name shown to customers; empty reuses name.

max_concurrent_appointmentsintegerOpcional1-999Valor predeterminado: 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 nullOpcional
Unix timestamp when this location was deactivated. None when active.
deactivation_reasonenum or nullOpcional
Why this location was deactivated. None when active.
Valores permitidos:

Errores

422
Unprocessable Entity Error