Skip to main content
POST
/
api
/
v1
/
mgt
/
workspaces
/
{workspaceId}
/
roles
Create Role
curl --request POST \
  --url https://api.xenia.team/api/v1/mgt/workspaces/{workspaceId}/roles \
  --header 'Content-Type: application/json' \
  --header 'x-client-key: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "title": "New Role Title",
  "description": "New Role test description",
  "permissions": [
    "dbf2e476-c880-4f1c-9ac6-a44bc3c0c9a7",
    "7790c9eb-8d55-4fe0-a52d-2e5e769e9588"
  ],
  "users": [
    "a437857a-463f-4ab7-997e-0e7b98e2b779",
    "08c25f22-c894-4d9d-bba2-ced36b8191bd"
  ],
  "reportTo": "43bc03d0-e0c5-41a1-bc13-2d232a40a728",
  "homepage": {
    "mobile": "DEFAULT",
    "web": "DEFAULT",
    "dashboard": {}
  }
}
'
{
  "data": {
    "createdAt": "2025-06-22T11:38:55.045Z",
    "updatedAt": "2025-06-22T11:38:55.045Z",
    "id": "198a9961-c365-46d4-8962-7f9720f21fae",
    "isActive": true,
    "order": 1,
    "title": "New Role Title",
    "description": "New Role test description",
    "editable": true,
    "reportTo": "43bc03d0-e0c5-41a1-bc13-2d232a40a728",
    "homepage": {
      "mobile": "DEFAULT",
      "web": "DEFAULT",
      "dashboard": {}
    },
    "workspaceId": "cb363f7e-c52a-4478-911d-f6a6f791090e",
    "createdBy": "dfea8b8a-5b22-4668-b68d-dc641eb3a101",
    "updatedBy": "dfea8b8a-5b22-4668-b68d-dc641eb3a101",
    "deletedAt": null
  },
  "meta": {}
}

Authorizations

​
x-client-key
string
header
required

Client API key for authentication

​
x-client-secret
string
header
required

Client secret for authentication

Path Parameters

​
workspaceId
string<uuid>
required

Workspace ID where the role will be created

Body

application/json
​
title
string
required

Name of the role

​
description
string

Description of the role

​
permissions
string<uuid>[]

List of permission IDs to assign to this role

​
users
string<uuid>[]

List of user IDs to assign to this role

​
reportTo
string<uuid>

Role ID that this role reports to

​
homepage
object

Response

Role created successfully

​
data
object
​
meta
object