Sign in
Reports

Update report

Changed on

Partially updates a report. 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 report 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 reports are purged after 90 days.

Note that reports on any dashboards cannot have their permissions updated; they inherit the dashboards' permissions. Attempting to update them will result in an error.

patch/analytics/reporting/2027-03-beta/reports/{reportId}

Request

  • Base URL: https://api.hubapi.com
  • URL: https://api.hubapi.com/analytics/reporting/2027-03-beta/reports/{reportId}
  • 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

reportIdinteger required

The ID of the report to update.

Request body

archivedboolean

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

businessUnitIdobject

The new business unit ID to use for the report. Set to null to reset to the account's default business unit. Omit to leave unchanged.

descriptionobject

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

namestring

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

ownerUserIdstring

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

Response

successful operation

archivedboolean required

Whether the report is archived.

archivedAtstring date-time

If the report is archived, the date and time when the report was archived, in ISO 8601 format. Absent if the report is not archived.

businessUnitIdstring required

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

createdAtstring date-time required

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

createdByUserIdstring

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

dashboardIdsstring[]

Array of IDs of the dashboards that this report is on.

For GET endpoints, only returned when requested by including the dashboardIds field in the properties query parameter. For other endpoints, not returned.

descriptionstring

A description of the report. May be absent.

idstring required

The ID of the report.

lastViewedAtstring date-time

The date and time when the report 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 report. Absent if it has not been viewed yet.

namestring required

The name of the report.

ownerUserIdstring

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

updatedAtstring date-time required

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

updatedByUserIdstring

The ID of the user who last updated the report. 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