Update Role

POST/web/v1/workspaces/{workspaceId}/roles/{roleId}/update JWT

Updates an existing custom workspace role's name and/or description.

Required Headers

Header	Example Value	Description
Content-Type	application/json	Request content type
Accept	application/json	Expected response type
X-Client-Hash		Client device fingerprint
Accept-Language	en, zh, zh-Hant, ja, vi	Response language (default: en)
Authorization	Bearer	JWT access token
X-Workspace-Id		Target workspace ID

Request Parameters

Name	Type	Required	In	Description
workspaceId	String	Required	path	Business ID of the workspace
roleId	String	Required	path	Business ID of the role

Request Body

{
  "roleName": "New Name",
  "description": "New description"
}

Request Example

{
  "roleName": "Senior Editor",
  "description": "Can edit and review"
}

Success Response

Status: 200 OK

Success 200

{
  "version": "1.3.0",
  "timestamp": 1709337600000,
  "success": true,
  "code": "2000",
  "message": "SUCCESS",
  "data": {
    "bizId": "ROLE_CUSTOM_TEST_001",
    "workspaceBizId": "WS_ROLE_TEST_001",
    "roleName": "New Name",
    "roleType": {
      "value": 10010902,
      "name": "CUSTOM",
      "code": "CUSTOM"
    },
    "description": "New description",
    "permissionCodes": null,
    "createdAt": "2026-03-22T10:30:00Z",
    "updatedAt": "2026-03-22T11:00:00Z"
  }
}

Error Responses

Unauthorized 401

{
  "success": false,
  "code": "4010",
  "message": "Invalid or expired token"
}

Conflict 409

{
  "success": false,
  "code": "WORKSPACE.OWNER_ROLE_PROTECTED",
  "message": "OWNER role cannot be modified"
}

Notes

• Only CUSTOM roles can be updated. Attempting to update an OWNER role returns 409 WORKSPACE.OWNER_ROLE_PROTECTED.
• Requires workspace:role:write permission.