Update a role name - DingTalk Help Center

Call this API to update a role name. This API does not allow you to modify roles in the “Default” group, including Person in charge, Supervisor, Super Admin, and Sub Admin.

Request

Basic information
HTTP URL	https://oapi.dingtalk.io/role/update_role
HTTP Method	POST
Supported app types	appType-Internal app
Required permissions	permission-qyapi_manage_addresslist-Contacts data management permission

Query parameters

Name	Type	Required	Example	Description
access_token	String	Yes	6d1bxxxx	The app credential used to call this API. Obtain it through the API for getting the access_token of an internal app.

Request body

Name	Type	Required	Example	Description
roleId	Number	Yes	1560985325	The ID of the role to update. You can obtain it by calling the Get role list API. Roles in the “Default” group cannot be modified, including: Person in charge, Supervisor, Super Admin, and Sub Admin.
roleName	String	Yes	Apparel manufacturing	The new role name.

Request example

curl -X POST "https://oapi.dingtalk.io/role/update_role" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=bb0d689c-e415-4fa5-b5d8-e16741e12b87' \
-d 'roleId=1' \
-d 'roleName=11'

Java

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/role/update_role");
OapiRoleUpdateRoleRequest req = new OapiRoleUpdateRoleRequest();
req.setRoleId(1560985325L);
req.setRoleName("Apparel manufacturing");
OapiRoleUpdateRoleResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

Python

import dingtalk.api

req=dingtalk.api.OapiRoleUpdateRoleRequest("https://oapi.dingtalk.io/role/update_role")

req.roleId=1
req.roleName="11"
try:
  resp= req.getResponse(access_token)
  print(resp)
except Exception,e:
  print(e)

PHP

include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiRoleUpdateRoleRequest;
$req->setRoleId("1");
$req->setRoleName("11");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.io/role/update_role");

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/role/update_role");
OapiRoleUpdateRoleRequest req = new OapiRoleUpdateRoleRequest();
req.RoleId = 1L;
req.RoleName = "11";
OapiRoleUpdateRoleResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

Response

Response body

Name	Type	Example	Description
errcode	Number	0	The return code.
errmsg	String	ok	The description of the return code.

Response body example

{
  "errcode":0,
  "errmsg":"ok"
}

Error codes

If an error occurs when calling this API, refer to the Global error codes document to find a solution based on the error message.

Error code (errcode)	Error message (errmsg)	Solution
660000	The parameter is empty	Complete the missing parameters.
33011	Invalid roleId	Check whether roleId is correct.
-1	The system is busy	Try again later.

​Request

​Query parameters

​Request body

​Request example

​Response

​Response body

​Response body example

​Error codes