HUhubspot
Advanced

Trigger a bulk snapshot of data for a given account and object type.

Changed on

Create a bulk snapshot of CRM objects in a HubSpot account which has installed your app. This endpoint is useful for capturing a large set of CRM data. The request requires specifying the account ID, object type, and a filter for property names. The response will be accepted and processed asynchronously. Subject to daily rate limits.

post/webhooks-journal/snapshots/2027-03-beta/crm-bulk

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/webhooks-journal/snapshots/2027-03-beta/crm-bulk
  • Auth
    none required

Request body

installPortalIdinteger required

The unique identifier of the account where the snapshot operation is to be performed. It is an integer formatted as int64.

objectTypeIdstring required

The type identifier of the CRM object for which the snapshot is being requested. It is a string.

pointInTimestring date-time

The specific date and time for which the snapshot should represent the state of the CRM objects, formatted as a date-time string.

propertyNameFilterstring[] required

An array of strings specifying the property names to include in the snapshot. This acts as a filter to limit the snapshot to certain properties. Empty array means all properties.

updatedAfterstring date-time

A date-time string indicating that only objects updated after this time should be included in the snapshot. It follows the date-time format.

Response

accepted

idstring required

A string representing the unique identifier for the bulk snapshot response.

installPortalIdinteger required

An integer in int64 format representing the account ID where the snapshot request was made.

linksobject

An object containing key-value pairs where keys are link names and values are associated URIs, potentially providing additional information or actions related to the snapshot.

objectTypeIdstring required

A string representing the type identifier of the CRM object for which the snapshot was requested.

Changes