Skip to content
/
Edit Team Member

Edit Team Member

Request

Security
BearerPartnerUser
Path
location_idnumberrequired

location ID

team_member_idnumberrequired

team member ID

Headers
Acceptstringrequired

e.g. application/vnd.api.v2+json

Example:application/vnd.api.v2+json
Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

Body*/*required
namestring

team member name

Example:"Basil"
specializationstring

team member specialization

Example:"the hairdresser"
weightnumber

team member weight. team members are sorted by weight on exit, heavier first

Example:10
informationstring

team member information (HTML format)

Example:"Trimming with three hands"
api_idstring

External team member ID

Example:"42"
hiddennumber

Display status in online appointment, 1 - hidden, 0 - not hidden

Example:0
firednumber

the team member's dismissal status, 1 - dismissed, 0 - not dismissed

Example:0
user_idnumber

Linked user ID, 0 - unlink user

Example:123
position_idnumber

Team Member Position ID. Applied on update only; on create, assign the Position with a subsequent update.

prepaidstring

Online payment requirement for this Team Member's online bookings

Enum:"forbidden""allowed""required"
image_group_idnumber

ID of the image group returned by the image upload endpoint (entity = team_member). Links the uploaded photo to the Team Member.

has_access_timetableboolean

Whether the team member has access to the appointment calendar (can have working hours set).

When true, the team member can be assigned schedules and appear in booking. When false (default for new team members), schedule-related operations will fail.

Note: This may be limited by your subscription plan.

Example:true
is_paid_staffboolean

Whether the team member is a paid staff member (optional)

Example:false
is_included_in_payment_policyboolean

Whether the team member is included in the location''s active payment policy scope (optional).

Toggling this field requires the payment_policy_update_access permission; otherwise the request fails with 403. The field is silently ignored when the payment_policy feature is disabled for the location or no active payment policy exists.

Example:true
curl -i -X PUT \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/locations/{location_id}/team_members/{team_member_id}' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: */*' \
  -d '{
    "name": "Basil",
    "specialization": "the hairdresser",
    "weight": 10,
    "information": "Trimming with three hands",
    "api_id": "42",
    "hidden": 0,
    "fired": 0,
    "user_id": 123,
    "has_access_timetable": true,
    "is_paid_staff": false,
    "is_included_in_payment_policy": true
  }'

Responses

OK

Bodyapplication/json
successboolean

Execution success status (true)

Example:true
dataobject

Team member data object

Example:
{
  "id": 1001539,
  "name": "team member 1",
  "company_id": 176275,
  "specialization": "team member",
  "position": {
    "id": 1,
    "title": "Administrator"
  },
  "avatar": "https://app.alteg.io/images/no-master-sm.png",
  "avatar_big": "https://app.alteg.io/images/no-master.png",
  "fired": 0,
  "status": 0,
  "hidden": 0,
  "user_id": 12345,
  "is_paid_staff": false,
  "is_included_in_payment_policy": true
}
metaArray of objects

Metadata (empty array)

Example:
[]
Response
{
  "success": true,
  "data": {
    "id": 17969,
    "api_id": 42,
    "name": "Basil",
    "specialization": "the hairdresser",
    "position": { … },
    "show_rating": 0,
    "rating": 0,
    "votes_count": 0,
    "user_id": 12345,
    "avatar": "https://app.alteg.io/uploads/masters/sm/20151018220924_4963.jpg",
    "avatar_big": "https://app.alteg.io/uploads/masters/norm/20151018220924_4963.jpg",
    "comments_count": 0,
    "weight": "10",
    "information": "<span><span><span>&nbsp;</span></span></span>",
    "hidden": "0",
    "fired": "0",
    "status": "0",
    "is_paid_staff": false,
    "is_included_in_payment_policy": true
  },
  "meta": []
}