Update Member

Important Note

This feature is available in the Business plan. If you haven't upgraded yet, please upgrade before using this feature.

API Overview

• Function: Update Member
• Request Method: POST
• Request URL: /api/contacts/teams/{team_id}/users/{user_id}?appid={appid}&access_token={access_token}

Request Parameters

Parameter Name	Type	Required	Location	Description	Example
team_id	integer	Yes	uri	Team ID	34
user_id	integer	Yes	uri	User ID	60000208205
group_ids	array[integer]	No	body	Group IDs	[86,87]
nickname	string	No	body	Contact Name	Li Si
avatar	string	No	body	Contact Avatar	https://wj.gtimg.com/default/default_headimg.png
role	integer	No	body	Role (Limited by team available seats)	2: Team Admin; 3: Survey Admin; 4: Regular Member
openid	string	No	body	User's unique identifier in third-party platform Only available for partner platforms This field is identical to open_id. If both are specified, only openid takes effect	abcdefg
open_id	string	No	body	User's unique identifier in third-party platform Only available for partner platforms This field is deprecated, please use openid	abcdefg

Response Parameters

None

Response Examples

• Successful Request

{
    "code": "OK",
    "error": {
        "type": ""
    },
    "data": {},
    "request_id": "10595b0f-9333-4ad7-8bda-ce2c00119758"
}

• Failed Request

{
    "code": "InvalidArgument",
    "error": {
        "type": "invalid_param"
    },
    "data": {},
    "request_id": "793fb149-4f12-4439-aa83-01d0e211b15c"
}

Error Codes

error.type Code	Description
contacts_user_not_found	User Not Found
group_edit_error	Failed to Modify Group
role_edit_error	Failed to Modify Role
exceed_user_limit	Exceeded Available User Limit
invalid_argument	Invalid Parameter
claim_error	No Permission