Skip to main content
PATCH
/
api
/
dashboard_widgets
/
{id}
Update a dashboard widget
curl --request PATCH \
  --url https://clarus-api.com/api/dashboard_widgets/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "data": {
    "type": "dashboard_widgets",
    "attributes": {
      "name": "Tasks by Type (last 7 days)",
      "configuration": {
        "metric": "total_records",
        "color_palette": "cool",
        "show_legend": true,
        "legend_position": "bottom",
        "horizontal": false,
        "log_scale": false,
        "limit": 5
      }
    }
  }
}
'
{
  "error": "<string>"
}

​
Request Structure

{
  "data": {
    "type": "dashboard_widgets",
    "attributes": {
      "name": "Tasks by Type (last 7 days)",
      "configuration": {
        "metric": "total_records",
        "color_palette": "cool",
        "show_legend": true,
        "legend_position": "bottom",
        "horizontal": false,
        "log_scale": false,
        "limit": 5
      }
    }
  }
}
See the create endpoint for the full list of widget_type values and the per-type configuration reference.

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 widget to update

Body

application/json
​
data
object
required

Response

Operation completed successfully with no content to return