Skip to main content

Create a Role

This article provides an example of calling the Create 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 create a new role named "Finance".

Follow these steps:

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

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

  3. Open the terminal on your computer and execute the following code to send an API request to the server (assuming the spaceId is spcjXzqVrjaP3):

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

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

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