Method Details
HTTP Methods:
POST
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers
Products:
CRM
Required Scope:
Signal the end of an import for an objectType
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:
| 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 |
| pageCount | In request body JSON | The total number of pages imported for this |
| itemCount | In request body JSON | The total number of messages for this |
| 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 |
| Optional Parameters | How to use | Description |
|---|---|---|
| None | None | No optional parameters for this method. |