Zur Navigation springen
ReceptionStaff

Update Staff Member

Update an existing staff member. Only the fields sent are changed.

Pfadparameter

staff_idstringErforderlich

Header

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

Anfrage

This endpoint expects an object.
groupslist of objectsOptional

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

ungrouped_rankinteger or nullOptional

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

namestringOptional

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

descriptionstringOptional
Description or bio of the staff member.
is_activebooleanOptional
Whether the staff member can be booked. Inactive staff keep their booking history.
emailstringOptional
Email address of the staff member.
phonestringOptional

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

sms_notifications_opted_inbooleanOptional

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 nullOptionalFormat: "uri"1-2083 characters
location_idstring or nullOptional

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

working_hoursobject or nullOptional

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

display_on_booking_pagebooleanOptional
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_namestringOptional

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.

Antwort

Erfolgreiche Antwort
namestring

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

_idstring
groupslist of objectsOptional

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

ungrouped_rankinteger or nullOptional>=0

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

descriptionstringOptional
Description or bio of the staff member.
is_activebooleanOptionalStandardwert ist true
Whether the staff member can be booked. Inactive staff keep their booking history.
emailstringOptionalStandardwert ist
Email address of the staff member.
phonestringOptional

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

sms_notifications_opted_inbooleanOptionalStandardwert ist 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 nullOptionalFormat: "uri"1-2083 characters
location_idstring or nullOptional

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

working_hoursobject or nullOptional

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

display_on_booking_pagebooleanOptionalStandardwert ist 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_namestringOptional

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_unixintegerOptional

Unix timestamp (seconds since epoch)

updated_at_unixintegerOptional

Unix timestamp (seconds since epoch)

Fehler

422
Unprocessable Entity Error