Skip to main content
PATCH
Update partially dashboard by ID

Authorizations

Authorization
string
header
required

Use a valid Bearer token to authenticate.

Path Parameters

id
string
required

Dashboard _id

Body

application/json

Fields to change

name
string
Maximum string length: 200
description
string
sharedRoleIds
string[]

Replaces the whole list. Role ids of the caller's organization, each distinct, at least one. An empty array is 400 dydsh-009, a repeated id is 400 dydsh-002, and a role of another organization or an unknown id is 400 dydsh-011. Visibility follows this list only: dropping the caller's own role hides the dashboard from the caller (404 dydsh-033 afterwards).

Maximum array length: 50
hubScope
object
timeRange
object

Default time window for the dashboard, or null. Not interpreted by the CRUD layer; the analytics endpoint accepts today, yesterday, last_7d, last_30d.

grid
object
widgets
object[]

The whole card array, in order. Omitted cards are removed.

updatedTime
string<date-time>

Lost-update precondition: the updatedTime from your last read. Absent, null or empty skips the check.

Response

Success - the updated dashboard, with widget definitions attached

status
boolean
Example:

true

code
integer
message
string
data
object