Dashboard Preferences
Update Dashboard Preferences
This endpoint updates the default or pinned status of a dashboard resource. The dashboard is identified by the dashboard_id parameter.
| Parameter | Description |
|---|---|
| dashboard_id | The id of the dashboard to edit must be submitted in the request. |
PATCH /api/v2/dashboards/{dashboard_id}/preferences
| Fields | Required | Description |
|---|---|---|
| pinned | No | The flag that sets whether a dashboard is pinned for a specific user. |
| default | No | The flag that sets whether a dashboard is set as default for a specific user. |
PATCH /api/v2/dashboards/3/preferences/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"
{
"pinned": true,
"default": true
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": 3,
"created": "2022-09-07T13:48:46.061536-04:00",
"created_by": {
"id": 1,
"email": "admin@example.com",
"first_name": "Admin",
"last_name": "Testerton",
"is_active": true,
"role": {
"id": "UR4",
"name": "Administrator"
}
},
"modified_by": {
"id": 1,
"email": "admin@example.com",
"first_name": "Admin",
"last_name": "Testerton",
"is_active": true,
"role": {
"id": "UR4",
"name": "Administrator"
}
},
"modified": "2022-09-07T13:48:46.061558-04:00",
"items": [
"..."
],
"pinned": true,
"default": true,
"title": "Example Dashboard Preferences",
"description": "",
"system": false
}