Update dashboard
Partially updates a dashboard. All fields in the request are optional; only the fields which are present will be updated.
Can also be used to archive or restore a dashboard using the archived field. When archived is present in a request, it must be the only field present, or it will result in an error. Archived dashboards are purged after 90 days.
Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The ID of the dashboard to update.
Body
Whether to archive (true) or restore (false) the dashboard. Cannot be combined with any other fields.
The new business unit ID to use for the dashboard. Set to null to reset to the account's default business unit. Omit to leave unchanged.
The new description to use for the dashboard. Set to null to clear the description. Omit to leave unchanged.
The new name to use for the dashboard. Omit to leave unchanged.
The ID of the user to change the dashboard's owner to. Omit to leave unchanged.
Response
successful operation
Whether the dashboard is archived.
The ID of the business unit that the dashboard is associated with.
The date and time when the dashboard was created, in ISO 8601 format.
The ID of the dashboard.
The name of the dashboard.
The date and time when the dashboard was last updated, in ISO 8601 format.
If the dashboard is archived, the date and time when the dashboard was archived, in ISO 8601 format. Absent if the dashboard is not archived.
The ID of the user who created the dashboard. May be absent.
A description of the dashboard. May be absent.
The date and time when the dashboard was last viewed, in ISO 8601 format. Absent if it has not been viewed yet.
The ID of the user who last viewed the dashboard. Absent if it has not been viewed yet.
The ID of the user who owns the dashboard. Absent if the dashboard is currently unowned.
Array of objects representing the tags that the dashboard is tagged with.
Only returned when requested by including the tags field in the properties query parameter.
The ID of the user who last updated the dashboard. May be absent.
An array of objects representing the widgets on the dashboard.
Only returned when requested by including the widgets field in the properties query parameter.