탐색으로 건너뛰기
ReceptionStaff

Update Staff Member

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

경로 매개변수

staff_idstring필수

헤더

xi-api-keystring선택 사항
xi-workspace-idstring or null선택 사항
The customer workspace a reseller's API key acts on.

요청

This endpoint expects an object.
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선택 사항

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

namestring선택 사항

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

descriptionstring선택 사항
Description or bio of the staff member.
is_activeboolean선택 사항
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선택 사항

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선택 사항
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