Update a profile. Practitioners may edit only their own profile and notification preferences. Deactivating someone with future bookings returns requires_staff_action unless force_reassign is given

patch/api/v1/team/{id}

Request

  • Base URL: http://127.0.0.1:4310
  • URL: http://127.0.0.1:4310/api/v1/team/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sfb_session

Path parameters

idstring required

Request body

namestring
display_namestring
titlestring
biostring
emailstring
colourstring
photo_urlstring

https only; needs photo_licence

photo_licencestring
location_idstring uuid
activeboolean
sortinteger
expected_versioninteger
notification_prefsobject

Events booking_created, booking_rescheduled, booking_cancelled, daily_schedule, leave_changes, client_message; channels email, sms

force_reassignobject

{ to_staff_id } or { assignments: [{ booking_id, staff_id }] } when deactivating someone with future bookings

Example request

{
  "colour": "#6b4f8a"
}

Response

OK

object required

Changes

No recorded changes to this operation across all 4 revisions of this API.