Update dashboard
curl --request PUT \
--url https://app.alana.shopping/api/workspace/{workspaceId}/dashboards/{dashboardId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"widgets": [
{
"widget_type": "<string>",
"position": {
"x": 24,
"y": 1,
"w": 24,
"h": 24
},
"config": {},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
'{
"dashboard": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"name": "<string>",
"layout": {
"version": 1,
"cols": 24,
"rowHeight": 136
},
"created_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>"
},
"widgets": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dashboard_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"widget_type": "<string>",
"position": {
"x": 24,
"y": 1,
"w": 24,
"h": 24
},
"config": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}Update Dashboard
Update dashboard metadata and (optionally) replace its widget set transactionally. Admin role required. When widgets is omitted, only the dashboard row is updated; when present, every widget on the dashboard is reconciled (insert/update/delete) in a single transaction.
PUT
/
api
/
workspace
/
{workspaceId}
/
dashboards
/
{dashboardId}
Update dashboard
curl --request PUT \
--url https://app.alana.shopping/api/workspace/{workspaceId}/dashboards/{dashboardId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"widgets": [
{
"widget_type": "<string>",
"position": {
"x": 24,
"y": 1,
"w": 24,
"h": 24
},
"config": {},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
'{
"dashboard": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"name": "<string>",
"layout": {
"version": 1,
"cols": 24,
"rowHeight": 136
},
"created_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>"
},
"widgets": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dashboard_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"widget_type": "<string>",
"position": {
"x": 24,
"y": 1,
"w": 24,
"h": 24
},
"config": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}Authorizations
Bearer token authentication via Auth0. Users authenticate through Auth0 Universal Login. Include the access token in the Authorization header: Authorization: Bearer <token>
Headers
Path Parameters
The workspace ID
Pattern:
^ws_[a-z0-9]+$Query Parameters
Body
application/json
Required string length:
1 - 120Maximum string length:
2000Show child attributes
Show child attributes
When present, replaces the widget set for this dashboard transactionally. Widgets without id are created; widgets with an id matching an existing row are updated; widgets in the DB but absent from this array are deleted.
Show child attributes
Show child attributes
Last modified on April 25, 2026
⌘I