Overview
Sets a member's attributes within a group, such as the member's group display name or group badge.
Request
Authentication: Add authentication headers to the request. See Authentication.
Method
POST
Rate limit
100 requests/second
Endpoint https://API domain/apigateway/groups/members/update
Content-Type
application/json
Request Parameters
| Parameter | Data Type | Required | Description | |
|---|---|---|---|---|
| group_id | string | Yes | Group ID. Maximum length: 64 characters. | |
| member_id | string | Yes | Group member ID. Maximum length: 32 characters. | |
| grp_display_name | string | No | Member's display name in the group. Maximum length: 100 characters. | |
| ext_fields | map | No | Additional member attributes in the group. Keys can contain up to 50 characters; values can contain up to 100 characters. |
Request Example
POST /apigateway/groups/members/update HTTP/1.1
appkey: appkey
signature: 2e639ae3600a4sdff61fb88b76f485b
nonce: nonce
timestamp: 1672568121910
Content-Type: application/json
{
"group_id":"groupid1",
"member_id":"member1",
"grp_display_name":"group display name",
"ext_fields":{
"k1":"v1",
"k2":"v2"
}
}
Response Example
{
"code":0,
"msg":"sucess"
}