Skip to main content

Update a Role

This article provides an example of calling the Update a role API.

  • This API is only available for spaces on the enterprise plan.(Learn more).
  • Only the primary admin and sub-admins who can manage roles can use this API.


Suppose you have a space and you want to rename the role "Finance A" to "Finance" and adjust its sequence to 2.

Follow these steps:

  1. Get your API Token. (How to get it)

  2. Get your Space ID. (How to get it)

  3. Get the unitId of the role "Finance A". (How to get it)

    What is unitId?

  4. Open the terminal on your computer and execute the following code to send a query request to the server (assuming the spaceId is spcjXzqVrjaP3 and the unitId of the role "Finance A" is pL5rZ6E9vTjXzJ7fK3xSsV2GqNnYyM4):

    curl -X PUT \
    "" \
    -H "Authorization: Bearer {Your API Token}" \
    -H 'Content-Type: application/json' \
    -d '{
  5. The server will return the following JSON data. The data under "data" is the information of the updated role:

    For the meaning of each parameter in the response, please check the API Reference.

    "code": 200,
    "success": true,
    "message": "SUCCESS",
    "data": {
    "role": {
    "unitId": "pL5rZ6E9vTjXzJ7fK3xSsV2GqNnYyM4",
    "name": "Finance",
    "sequence": 2002