Passer à la navigation
ReceptionStaff

Create Staff Member

Create a new staff member

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 staff member, 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 or bio of the staff member.
is_activebooleanOptionnelPar défaut true
Whether the staff member can be booked. Inactive staff keep their booking history.
emailstringOptionnelPar défaut
Email address of the staff member.
phonestringOptionnel

Phone number of the staff member. Without a country code, +1 (US) is assumed.

sms_notifications_opted_inbooleanOptionnelPar défaut false

Whether this staff member currently receives SMS booking notifications. Defaults to opted out — a staff member must be explicitly opted in; flipped to False automatically when they reply STOP to the workspace number.

photo_urlstring or nullOptionnelformat: "uri"1-2083 characters
location_idstring or nullOptionnel

Location this staff member is assigned to; empty means available at all locations.

working_hoursobject or nullOptionnel

Custom working hours for this staff member. Null means follow the assigned location’s operating_hours (requires location_id).

display_on_booking_pagebooleanOptionnelPar défaut true
Whether customers can see and pick this staff member by name on the booking page. False keeps them bookable, just not shown by name.
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 staff member, 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 or bio of the staff member.
is_activebooleanOptionnelPar défaut true
Whether the staff member can be booked. Inactive staff keep their booking history.
emailstringOptionnelPar défaut
Email address of the staff member.
phonestringOptionnel

Phone number of the staff member. Without a country code, +1 (US) is assumed.

sms_notifications_opted_inbooleanOptionnelPar défaut false

Whether this staff member currently receives SMS booking notifications. Defaults to opted out — a staff member must be explicitly opted in; flipped to False automatically when they reply STOP to the workspace number.

photo_urlstring or nullOptionnelformat: "uri"1-2083 characters
location_idstring or nullOptionnel

Location this staff member is assigned to; empty means available at all locations.

working_hoursobject or nullOptionnel

Custom working hours for this staff member. Null means follow the assigned location’s operating_hours (requires location_id).

display_on_booking_pagebooleanOptionnelPar défaut true
Whether customers can see and pick this staff member by name on the booking page. False keeps them bookable, just not shown by name.
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