Skip to main content
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
      ]
    }
  }
}
'
{
  "error": "<string>"
}

​
Request Structure

{
  "data": {
    "type": "dashboards",
    "attributes": {
      "name": "Warehouse Operations (live)",
      "is_default": true,
      "role_ids": [1, 4, 7]
    }
  }
}

​
Notes

  • role_ids replaces 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

​
Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

​
X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Path Parameters

​
id
integer
required

The unique identifier of the dashboard to update

Body

application/json
​
data
object
required

Response

Operation completed successfully with no content to return