Skip to main content
PUT
Update dashboard

Authorizations

Authorization
string
header
required

Bearer token authentication via Auth0. Users authenticate through Auth0 Universal Login. Include the access token in the Authorization header: Authorization: Bearer <token>

Headers

X-Active-Brand
string<uuid>

Path Parameters

workspaceId
string
required

The workspace ID

Pattern: ^ws_[a-z0-9]+$
dashboardId
string<uuid>
required

Query Parameters

brand_id
string<uuid>

Body

application/json
name
string
Required string length: 1 - 120
description
string | null
Maximum string length: 2000
layout
object
widgets
object[]

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.

Response

Dashboard + widgets after update

dashboard
object
required
widgets
object[]
required
Last modified on April 25, 2026