탐색으로 건너뛰기
ReceptionLocations

Create Location

Add a new business location.

헤더

xi-api-keystring선택 사항
xi-workspace-idstring or null선택 사항
The customer workspace a reseller's API key acts on.

요청

This endpoint expects an object.
namestring필수
Internal name, e.g. 'Main Office' or 'Downtown Branch', shown in the dashboard and owner notifications.
addressstring선택 사항
Street address.
notesstring선택 사항
Directions or other notes for customers, e.g. 'Free parking behind the building'.
operating_hoursobject or null선택 사항

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

customer_facing_namestring선택 사항

Name shown to customers; empty reuses name.

max_concurrent_appointmentsinteger선택 사항1-999기본값 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_activeboolean선택 사항기본값 true

응답

성공 응답

namestring
Internal name, e.g. 'Main Office' or 'Downtown Branch', shown in the dashboard and owner notifications.
_idstring
is_activeboolean읽기 전용
addressstring선택 사항
Street address.
notesstring선택 사항
Directions or other notes for customers, e.g. 'Free parking behind the building'.
operating_hoursobject선택 사항
customer_facing_namestring선택 사항

Name shown to customers; empty reuses name.

max_concurrent_appointmentsinteger선택 사항1-999기본값 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 null선택 사항
Unix timestamp when this location was deactivated. None when active.
deactivation_reasonenum or null선택 사항
Why this location was deactivated. None when active.
허용된 값:

오류

422
Unprocessable Entity Error