Update a user group

Request URL

PUT {base_url}/services/openapi/v1.0/user/group_update

Request parameter

Body parameters


Parameter	Required	Type	Description
groupId	Yes	Long	User group ID. Note: You can query the user group ID using the Query Multiple User Groups interface.
groupName	Yes	String	User group name.

Response parameter


Parameter	Type	Description
data	Object <Details>	The detailed information.
status	String	The result of the request. `Success` `Failed`
requestId	String	The ID of the request, which can be used to quickly locate the request.

Details


Parameter	Type	Description
groupId	Long	User group ID.

Example

Request example

Change the name of the user group (ID: 1001391) from

API
                    Test Group

to

API Test Group
                    Plus

.

PUT /services/openapi/v1.0/user/group_update HTTP/1.1
Host: workplace.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJncmFudF90eXBlIjoiY2xpZW50X2NyZWRlbnRpYWxzIiwic2NvcGUiOlsiL29wZW5hcGkvIl0sImVudGVycHJpc2VfaWQiOjEwMDQzMywicmVnaW9uIjoiR0wiLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJjZjc3NTg4OC1mM2QwLTRkNDMtODJiYy00NjQ4NWZjYTY0MzIiLCJjbGllbnRfaWQiOiI3OTU2OGFhMC0wYjBkLTQyZjYtOGRiNC03OWExNmQ3MzQ3MmEiLCJ0cyI6MTY4OTkwNTE3MCwiZXhwX2luIjo4NjQwMH0.QULcMVk5CJWNnZFrHp2TYH-P1cdvPoFn4jYYEwSs0Ps
Content-Type: application/json

{
    "groupId": 1001391,
    "groupName": "API Test Group Plus"
}

Response example

HTTP/1.1 200 OK
{
    "data": {
        "groupId": 1001391
    },
    "status": "Success",
    "requestId": "1747d2006a87d16d616854721899845c"
}