Update a dashboard
Reports module
PATCH/dashboards/{id}dashboards.update
A grid of report tiles, saved per user or per team. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.
- Requires the capability reports.report.write.
- OAuth scopes: reports.
- Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
- Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the dashboard. |
Request body: DashboardUpdate
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | No | Dashboard name.Constraints: length 1 to 300 |
| team_id | string (uuid) | null | No | Identifier of the team. |
{
"name": "Show Week",
"team_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Response 200: Dashboard
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the dashboard. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| name | string | Yes | Dashboard name.Constraints: length 1 to 300 |
| team_id | string (uuid) | null | Yes | Identifier of the team. |
| membership_id | string (uuid) | null | Yes | Identifier of the membership that owns the dashboard. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"name": "Show Week",
"team_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Code samples
curl -X PATCH "$XOS_BASE_URL/dashboards/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H 'If-Match: W/"etag-from-your-last-read"' \
-H "Content-Type: application/json" \
-d '{"name":"Show Week","team_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'const { data, etag } = await xos.dashboards.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"name": "Show Week",
"team_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}, { ifMatch: etag });response = xos.dashboards.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"name": "Show Week", "team_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}, if_match=etag)xos dashboards update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"name":"Show Week","team_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}' --if-match auto