There's a new version of the HubSpot API

As of November 30, 2022, HubSpot API keys are no longer a supported authentication method for accessing HubSpot APIs. Instead, you should use a private app access token or OAuth to authenticate API calls. Learn more about this change and how to migrate an API key integration to use a private app instead.

Create or update a group of timeline events

Last updated June 17, 2020

PUT /integrations/v1/:application‐id/timeline/event/batch

Method Details

HTTP Methods:

PUT

Content Type:

application/json

Response Format:

N/A

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing & CRM

Required Scope:

timeline

Create or update a group of timeline events. This can be used to backfill events when your integration is first installed, or to efficiently sync a large number of events occurring over a short period of time. Up to 100 events can be included in a single batch.

See the Timeline Overview for more details about creating and working with events.

See creating or updating a single event for more details about the data that should be included for each event.

Required Parameters How to use Description
OAuth Access Token Authorization: Bearer {token}
Used in the request headers
Used to authenticate the request. Please see this page for more details about authentication.
NOTE: You must use an OAuth access token to create an event. API keys are not supported.
application-id Used in the request URL The ID of the application that the event type was created for. The eventTypeId used in the request body must line up with this application-id.
Events list "eventWrappers": []
Used in the request body
A list of events that you want to create or update. See creating or updating an event for more details on the format used for events.
Up to 100 events can be included in a single batch.

Returns a 204 No Content response on success.Otherwise, you'll receive a 4xx error, with more details about the specific error in the body of the response.

Note: if there are any problems with the request, the entire batch will fail, so a 4xx response means that no events will be created or updated.