Skip to main content
PATCH
/
api
/
v1
/
mgt
/
workspaces
/
{workspaceId}
/
roles
/
{roleId}
Update Role
curl --request PATCH \
  --url https://api.xenia.team/api/v1/mgt/workspaces/{workspaceId}/roles/{roleId} \
  --header 'Content-Type: application/json' \
  --header 'x-client-key: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "permissions": [
    "7790c9eb-8d55-4fe0-a52d-2e5e769e9588",
    "dbf2e476-c880-4f1c-9ac6-a44bc3c0c9a7"
  ],
  "title": "New Role Title - edit",
  "description": "New Role test description",
  "reportTo": "43bc03d0-e0c5-41a1-bc13-2d232a40a728",
  "homepage": {
    "mobile": "PULSE",
    "web": "PULSE",
    "dashboard": {}
  }
}
'
{
  "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

roleId
string<uuid>
required

Role ID

Body

application/json
permissions
string<uuid>[]

List of permission IDs

title
string

Role title

description
string

Role description

reportTo
string<uuid>

Role ID that this role reports to

homepage
object

Response

Role successfully updated

meta
object