Update dashboard — StatusDashboard Docs

PATCH /app/dashboards/{id}

Updates a dashboard's general settings. All fields are optional — only the fields provided are updated.

This endpoint updates only the core general fields. Tab-specific settings are updated via dedicated endpoints — see Domains, Components, Content, Custom Code, Branding, Widget, and Whitelabel.

Path parameters

Parameter	Description
`id`	The UUID of the dashboard.

Request

See API Basics for required headers.

Request body

At least one field must be provided.

Field	Type	Description
`name`	string	Display name. Maximum 50 characters. Must be unique within the organization (case-insensitive).
`pageTitle`	string	Text shown in the upper-left header of the status dashboard and in the browser tab. Maximum 40 characters.
`description`	string	Dashboard description. Maximum 500 characters.
`systemMessage`	string	Optional message displayed at the top of the status dashboard. Rich text field. See Rich text fields. Max 1,000 characters. Pass an empty string to remove.
`enabled`	boolean	Set to `false` to disable the dashboard. Disabled dashboards return `404` for all requests.

Sample request

curl -X PATCH https://api.statusdashboard.com/app/dashboards/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer bcf847abf5c6:def456" \
  -H "Content-Type: application/json" \
  -d '{
    "pageTitle": "Acme System Status",
    "systemMessage": ""
  }'

Sample response

Status: 200 OK

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Production Status",
  "pageTitle": "Acme System Status",
  "description": "Status dashboard for all Acme services",
  "enabled": true,
  "updatedAt": "2026-04-01T08:00:00.000Z"
}

Error responses

Status	When
`400`	Validation failure or no fields provided.
`403`	Insufficient permissions.
`404`	Dashboard not found or does not belong to the caller's organization.
`409`	Dashboard name already exists in the organization (case-insensitive).