Skip to main content
PATCH
Update dashboard

Authorizations

X-API-Key
string
header
required

API key for authentication

Path Parameters

dashboard_id
string
required

Dashboard resource ID (22-character ShortUUID)

Body

application/json

All fields optional (PATCH semantics). Provided fields are updated; omitted or null fields are left unchanged. Setting is_default=true unsets any other default dashboard in the organization. config fully replaces the stored blob; to clear a value send an empty string (description) or an empty object (config) rather than null.

display_name
string | null

Updated dashboard name

Required string length: 1 - 255
description
string | null

Updated free-text description (empty string clears it)

Maximum string length: 1000
is_favorite
boolean | null

Updated favorite flag

is_default
boolean | null

Set true to make this the organization's default dashboard (unsets any other default)

position
integer | null

Updated ordering position

Required range: x >= 0
config
object | null

Replacement free-form JSON config blob (max 50000 bytes serialized)

Response

Dashboard updated successfully

dashboard
object
required

Dashboard resource