नेविगेशन पर जाएँ
ReceptionStaff

Create Staff Member

Create a new staff member

हेडर

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/admin name of the staff member, shown in the dashboard and owner notifications.

groupslist of objectsवैकल्पिक

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

ungrouped_rankinteger or nullवैकल्पिक>=0

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

descriptionstringवैकल्पिक
Description or bio of the staff member.
is_activebooleanवैकल्पिकडिफ़ॉल्ट: true
Whether the staff member can be booked. Inactive staff keep their booking history.
emailstringवैकल्पिकडिफ़ॉल्ट:
Email address of the staff member.
phonestringवैकल्पिक

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

sms_notifications_opted_inbooleanवैकल्पिकडिफ़ॉल्ट: 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 nullवैकल्पिकफ़ॉर्मेट: "uri"1-2083 characters
location_idstring or nullवैकल्पिक

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

working_hoursobject or nullवैकल्पिक

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

display_on_booking_pagebooleanवैकल्पिकडिफ़ॉल्ट: 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_namestringवैकल्पिक

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.

रिस्पॉन्स

सफल रिस्पॉन्स

namestring

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

_idstring
groupslist of objectsवैकल्पिक

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

ungrouped_rankinteger or nullवैकल्पिक>=0

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

descriptionstringवैकल्पिक
Description or bio of the staff member.
is_activebooleanवैकल्पिकडिफ़ॉल्ट: true
Whether the staff member can be booked. Inactive staff keep their booking history.
emailstringवैकल्पिकडिफ़ॉल्ट:
Email address of the staff member.
phonestringवैकल्पिक

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

sms_notifications_opted_inbooleanवैकल्पिकडिफ़ॉल्ट: 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 nullवैकल्पिकफ़ॉर्मेट: "uri"1-2083 characters
location_idstring or nullवैकल्पिक

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

working_hoursobject or nullवैकल्पिक

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

display_on_booking_pagebooleanवैकल्पिकडिफ़ॉल्ट: 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_namestringवैकल्पिक

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_unixintegerवैकल्पिक

Unix timestamp (seconds since epoch)

updated_at_unixintegerवैकल्पिक

Unix timestamp (seconds since epoch)

त्रुटियाँ

422
Unprocessable Entity Error