Update a role
curl --request PATCH \
--url https://clarus-api.com/api/roles/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"data": {
"type": "roles",
"attributes": {
"name": "<string>",
"description": "<string>",
"permissions": [
"<string>"
]
}
}
}
'import requests
url = "https://clarus-api.com/api/roles/{id}"
payload = { "data": {
"type": "roles",
"attributes": {
"name": "<string>",
"description": "<string>",
"permissions": ["<string>"]
}
} }
headers = {
"Authorization": "Bearer <token>",
"X-Clarus-Subdomain": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'X-Clarus-Subdomain': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
data: {
type: 'roles',
attributes: {name: '<string>', description: '<string>', permissions: ['<string>']}
}
})
};
fetch('https://clarus-api.com/api/roles/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": 123,
"type": "roles",
"attributes": {
"name": "<string>",
"description": "<string>",
"permissions": [
"<string>"
]
}
}
}{
"error": "<string>"
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}Roles
Update a role
Update an existing role’s name, description, or permissions.
PATCH
/
api
/
roles
/
{id}
Update a role
curl --request PATCH \
--url https://clarus-api.com/api/roles/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"data": {
"type": "roles",
"attributes": {
"name": "<string>",
"description": "<string>",
"permissions": [
"<string>"
]
}
}
}
'import requests
url = "https://clarus-api.com/api/roles/{id}"
payload = { "data": {
"type": "roles",
"attributes": {
"name": "<string>",
"description": "<string>",
"permissions": ["<string>"]
}
} }
headers = {
"Authorization": "Bearer <token>",
"X-Clarus-Subdomain": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'X-Clarus-Subdomain': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
data: {
type: 'roles',
attributes: {name: '<string>', description: '<string>', permissions: ['<string>']}
}
})
};
fetch('https://clarus-api.com/api/roles/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": 123,
"type": "roles",
"attributes": {
"name": "<string>",
"description": "<string>",
"permissions": [
"<string>"
]
}
}
}{
"error": "<string>"
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}Request Structure
{
"data": {
"type": "roles",
"attributes": {
"name": "Senior Warehouse Manager",
"permissions": ["manage_stock", "manage_orders", "view_reports", "manage_users"]
}
}
}
Key Fields
| Field | Required | Description |
|---|---|---|
name | No | Updated role name |
description | No | Updated description |
permissions | No | Updated permission list |
Authorizations
OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.
The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.
Path Parameters
The unique identifier of the role to update
Body
application/json
Show child attributes
Show child attributes
Response
Role updated successfully
Show child attributes
Show child attributes
⌘I

