跳到导航
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