Sign in
Dashboards

Update dashboard

Changed on

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.

patch/analytics/reporting/2027-03-beta/dashboards/{dashboardId}

Request

  • Base URL: https://api.hubapi.com
  • URL: https://api.hubapi.com/analytics/reporting/2027-03-beta/dashboards/{dashboardId}
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: reporting.full.edit)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: reporting.full.write)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: reporting.full.admin)

Path parameters

dashboardIdinteger required

The ID of the dashboard to update.

Request body

archivedboolean

Whether to archive (true) or restore (false) the dashboard. Cannot be combined with any other fields.

businessUnitIdobject

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.

descriptionobject

The new description to use for the dashboard. Set to null to clear the description. Omit to leave unchanged.

namestring

The new name to use for the dashboard. Omit to leave unchanged.

ownerUserIdstring

The ID of the user to change the dashboard's owner to. Omit to leave unchanged.

Response

successful operation

archivedboolean required

Whether the dashboard is archived.

archivedAtstring date-time

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.

businessUnitIdstring required

The ID of the business unit that the dashboard is associated with.

createdAtstring date-time required

The date and time when the dashboard was created, in ISO 8601 format.

createdByUserIdstring

The ID of the user who created the dashboard. May be absent.

descriptionstring

A description of the dashboard. May be absent.

idstring required

The ID of the dashboard.

lastViewedAtstring date-time

The date and time when the dashboard was last viewed, in ISO 8601 format. Absent if it has not been viewed yet.

lastViewedByUserIdstring

The ID of the user who last viewed the dashboard. Absent if it has not been viewed yet.

namestring required

The name of the dashboard.

ownerUserIdstring

The ID of the user who owns the dashboard. Absent if the dashboard is currently unowned.

updatedAtstring date-time required

The date and time when the dashboard was last updated, in ISO 8601 format.

updatedByUserIdstring

The ID of the user who last updated the dashboard. May be absent.

Changes

  • 2027-03-beta2d237e903dfcRevision changes
    • ○

      the security scope reporting.full.edit was added to the endpoint's security scheme oauth2

    • ○

      the security scope reporting.full.admin was removed from the endpoint's security scheme oauth2

  • 2027-03-betaae16703bd7c6Revision changes
    • ○

      the security scope reporting.full.edit was added to the endpoint's security scheme oauth2

    • ○

      the security scope reporting.full.admin was removed from the endpoint's security scheme oauth2

    • ○

      added the optional property /// to the response with the status