Skip to main content
DELETE
/
api
/
dashboard_widgets
/
{id}
Delete a dashboard widget
curl --request DELETE \
  --url https://clarus-api.com/api/dashboard_widgets/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Clarus-Subdomain: <api-key>'
{
  "error": "<string>"
}

​
Behavior

  • Returns 204 No Content on success
  • Removes all placements of the widget from every dashboard it was placed on
  • This action is permanent and cannot be undone

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 delete

Response

Operation completed successfully with no content to return