There's a new version of the HubSpot API
Starting November 30, 2022, API keys will be sunset as an authentication method. Learn more about this change and how to migrate an API key integration to use a private app instead.
HTTP Methods:
POST
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers
Products:
CRM
Required Scope:
Import a page of ecommerce data upon customer request.
Up to 200 import messages can be included in a single request.
| Required Parameters | How to use | Description |
|---|---|---|
| OAuth Access Token or API Key | Authorization: Bearer {token} header or hapikey={key} query parameter. |
Used to authenticate the request. Please see this page for more details about authentication. |
| importStartedAt | In request body JSON | Timestamp from the webhook when the customer requested imported in HubSpot UI |
| pageNumber | In request body JSON | Integer starting at zero of the page number for that objectType |
| messages | In request body JSON | Array of sync messages for this page of imports. Up to 200 messages can be included. |
| storeId | In request body JSON | The key of the store for this import
|
| objectType | In request body JSON | The HubSpot object this page of imports is for. Must be one of CONTACT, DEAL, LINE_ITEM or PRODUCT |
