StatusDashboard
DashboardsWhitelabel

Update dashboard whitelabel

Toggle the whitelabel setting for a dashboard.

View Markdown

PATCH /app/dashboards/{id}/whitelabel

Enables or disables the whitelabel setting for a dashboard. Requires the Whitelabel feature entitlement.

When enabled, the "Powered by StatusDashboard" footer branding is hidden on this status dashboard.


Path parameters

ParameterDescription
idThe UUID of the dashboard.

Request

See API Basics for required headers.

Request body

FieldTypeDescription
enabledbooleanRequired. Set to true to hide the "Powered by StatusDashboard" footer on the status dashboard.

Sample request

curl -X PATCH https://api.statusdashboard.com/app/dashboards/a1b2c3d4-e5f6-7890-abcd-ef1234567890/whitelabel \
  -H "Authorization: Bearer bcf847abf5c6:def456" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true
  }'

Sample response

Status: 200 OK

{
  "enabled": true
}

Error responses

StatusWhen
400Validation failure — whitelabelEnabled is missing or not a boolean.
403Insufficient permissions, or the Whitelabel feature is not enabled.
404Dashboard not found or does not belong to the caller's organization.

On this page

We use cookies

We use essential cookies to keep the site working, and optional analytics cookies to understand how it's used. Read our Privacy Policy.