Skip to main content
PATCH
Update a dashboard category

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Path Parameters

id
string
required

DashboardCategory identifier

Body

application/merge-patch+json

The updated DashboardCategory resource

tenant
string<iri-reference>
Example:

"/api/v1/tenants/1"

name
string | null
layoutType
string
widgets
string<iri-reference>[]
Example:
position
integer
default:0
isActive
boolean
default:true
isCollapsed
boolean
default:false
dateCreated
string<date-time>
dateUpdated
string<date-time>

Response

DashboardCategory resource updated

id
integer
read-only
tenant
string<iri-reference>
Example:

"/api/v1/tenants/1"

name
string | null
layoutType
string
widgets
string<iri-reference>[]
Example:
position
integer
default:0
isActive
boolean
default:true
isCollapsed
boolean
default:false
dateCreated
string<date-time>
dateUpdated
string<date-time>
systemCategory
boolean
read-only
maxWidgets
integer | null
read-only