Update dashboard
PUT/v2/illuminate/dashboards/:id
Updates an existing dashboard. Same request body as create.
Warning: The
chartsarray is a full replacement. Omitting a chart from the array deletes it. To keep existing charts, include them with theircharts[].id.
Field behavior on PUT
| Field | Behavior |
|---|---|
name | Replaced |
dateRange | Replaced |
startDate / endDate | Required when dateRange is "Custom date" |
charts | Full replacement — include id for existing charts |
customerId | Cannot be changed after creation |
Common errors
| Status | Cause |
|---|---|
400 | Missing charts[].id for an existing chart (creates duplicate instead of updating) |
404 | Dashboard ID does not exist |
Request
Example
{
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z",
"createdBy": "string",
"updatedBy": "string",
"id": "string",
"name": "string",
"accountId": "string",
"dateRange": "30 minutes",
"startDate": "2024-01-01T00:00:00.000Z",
"endDate": "2024-01-01T00:00:00.000Z",
"charts": [
{
"id": "access_manager_by_metric",
"series": [
{}
]
}
],
"customer": {
"id": "string",
"name": "string"
}
}