Update a dashboard
curl --request PATCH \
--url https://clarus-api.com/api/dashboards/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"data": {
"type": "dashboards",
"attributes": {
"name": "Warehouse Operations (live)",
"is_default": true,
"role_ids": [
1,
4,
7
]
}
}
}
'import requests
url = "https://clarus-api.com/api/dashboards/{id}"
payload = { "data": {
"type": "dashboards",
"attributes": {
"name": "Warehouse Operations (live)",
"is_default": True,
"role_ids": [1, 4, 7]
}
} }
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: 'dashboards',
attributes: {name: 'Warehouse Operations (live)', is_default: true, role_ids: [1, 4, 7]}
}
})
};
fetch('https://clarus-api.com/api/dashboards/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"error": "<string>"
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}Dashboards
Update a dashboard
Update an existing dashboard’s attributes. All fields are optional; only supplied fields are updated. Setting is_default: true clears the default flag from every other dashboard.
PATCH
/
api
/
dashboards
/
{id}
Update a dashboard
curl --request PATCH \
--url https://clarus-api.com/api/dashboards/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"data": {
"type": "dashboards",
"attributes": {
"name": "Warehouse Operations (live)",
"is_default": true,
"role_ids": [
1,
4,
7
]
}
}
}
'import requests
url = "https://clarus-api.com/api/dashboards/{id}"
payload = { "data": {
"type": "dashboards",
"attributes": {
"name": "Warehouse Operations (live)",
"is_default": True,
"role_ids": [1, 4, 7]
}
} }
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: 'dashboards',
attributes: {name: 'Warehouse Operations (live)', is_default: true, role_ids: [1, 4, 7]}
}
})
};
fetch('https://clarus-api.com/api/dashboards/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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": "dashboards",
"attributes": {
"name": "Warehouse Operations (live)",
"is_default": true,
"role_ids": [1, 4, 7]
}
}
}
Notes
role_idsreplaces the existing role associations — supply the full set you want associated, not a delta.- Widget placements are managed through
PUT /api/dashboards/{id}/widgets, not through this endpoint.
Authorizations
OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.
FlowAuthorization Code
- Authorization URL
- https://clarus-api.com/oauth/authorize
- Token URL
- https://clarus-api.com/oauth/token
FlowClient Credentials
- Token URL
- https://clarus-api.com/oauth/token
The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.
Path Parameters
The unique identifier of the dashboard to update
Body
application/json
Show child attributes
Show child attributes
Response
Operation completed successfully with no content to return

