Passer à la navigation
ReceptionAssets

Create Asset

Create a bookable asset, such as a room or a piece of equipment.

En-têtes

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

Requête

This endpoint expects an object.
namestringRequis

Internal/admin name of the asset, shown in the dashboard and owner notifications.

groupslist of objectsOptionnel

Group memberships for this item. Each entry carries the group label and the item’s 0-based rank within that group.

ungrouped_rankinteger or nullOptionnel>=0

Display position among items with no group; null sorts last. Change it with the reorder endpoint.

descriptionstringOptionnel
Description of the asset.
is_activebooleanOptionnelPar défaut true
Whether the asset can be booked. Inactive assets keep their booking history.
available_hoursobject or nullOptionnel

Custom availability hours for this asset. Null means follow the assigned location’s operating_hours (requires location_id).

photo_urlstring or nullOptionnelformat: "uri"1-2083 characters
URL of a photo of the asset.
location_idstring or nullOptionnel

Location this asset belongs to; empty means available at all locations.

customer_facing_namestringOptionnel

Optional public-facing label. When empty, name is shown to customers too. name stays the internal/admin label used in the dashboard and business-owner notifications.

Réponse

Réponse réussie

namestring

Internal/admin name of the asset, shown in the dashboard and owner notifications.

_idstring
groupslist of objectsOptionnel

Group memberships for this item. Each entry carries the group label and the item’s 0-based rank within that group.

ungrouped_rankinteger or nullOptionnel>=0

Display position among items with no group; null sorts last. Change it with the reorder endpoint.

descriptionstringOptionnel
Description of the asset.
is_activebooleanOptionnelPar défaut true
Whether the asset can be booked. Inactive assets keep their booking history.
available_hoursobject or nullOptionnel

Custom availability hours for this asset. Null means follow the assigned location’s operating_hours (requires location_id).

photo_urlstring or nullOptionnelformat: "uri"1-2083 characters
URL of a photo of the asset.
location_idstring or nullOptionnel

Location this asset belongs to; empty means available at all locations.

customer_facing_namestringOptionnel

Optional public-facing label. When empty, name is shown to customers too. name stays the internal/admin label used in the dashboard and business-owner notifications.

created_at_unixintegerOptionnel

Unix timestamp (seconds since epoch)

updated_at_unixintegerOptionnel

Unix timestamp (seconds since epoch)

Erreurs

422
Unprocessable Entity Error