API ReferenceDashboard

Create or Update User Dashboard Settings

Create or Update User Dashboard Settings

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

x-integration-namestringOptional
The name of the calling system passed along as a header parameter

Request

User dashboard settings object
idstring or nullOptionalformat: "uuid"
Unique ID
userIdstring or nullOptionalformat: "uuid"
User ID
typestringOptional
Either custom or one of DashboardType enum
reactGridLayoutobject or nullOptional
React grid layout configuration

Response

Success
errorobject or null
If the API call failed, this will contain information about the error that occurred.
successboolean or null

True if the API call succeeded; false otherwise.

hasErrorboolean or null
True if the API call failed.
statusCodeenum or null
The HTTP code of the response.
dataobject or null
The Dashboards API is intended for use by ProjectManager