Help Center/ KooDrive/ API Reference/ API/ Group Management/ Modifying Group Information

Updated on 2024-07-30 GMT+08:00

View PDF

Modifying Group Information

Function

Modify group information.

URI

PUT /koodrive/ose/v1/usergroups/{group_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
group_id	Yes	String

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Authorization	Yes	String	Access token. Token authentication is used to call KooDrive APIs. A token indicates the permission. When an API is called, the token is added to the request header to obtain the operation permission. For details about how to obtain an access token, see the corresponding developer guide. The format is Bearer+{access_token}.
X-Traceid	No	String	Message log trace ID. The value contains 58 bits.
language	No	String	Language code, which complies with the internationalization specifications. For example, en-US indicates English (United States). English (United States) is used by default.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
groupName	Yes	String	User group name.
userId	No	String	User ID.
role	No	String	User group role.
iconUrl	No	String	Link of the group profile picture.
top	No	String	Whether this record is pinned to top. 1: pinned to top. 0: displayed in sequence.
sourceType	Yes	Integer	User group type.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
code	String	Response code.
msg	String	Response information.

Example Requests

Updates the group information of department 1289173650183882753.

PUT /koodrive/ose/v1/usergroup/1289173650183882753

Authorization:Bearer+c69b0f40334782d560bb154032cf22ef43d671843c4ffbad

{
  "groupName": "123",
  "sourceType": 0
}