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:
PUT
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers
Products:
Marketing & CRM
Required Scope:
Send a group of sync messages for a specific object type. Sync messages would be notifications of creates, updates, or deletes of ecommerce objects.
Up to 200 sync 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. |
| Object Type | "objectType": xxxx Used in the request body |
The object type that the updates are for. One of CONTACT, DEAL, PRODUCT, or LINE_ITEM. |
| Store Id |
"storeId":xxxx |
The ID of the store that the objects are being synced for. |
| Messages | "messages":[ ...] Used in the request body |
Array of message objects - up to 200 messages can be submitted in the same batch |
The request will be a list of sync messages. Each message must include the following fields.
| Field name | Field type | Description |
|---|---|---|
| externalObjectId | String, max length 100 characters, ascii-only | The ID, in your system, of the object that is being created, updated, or deleted. |
| action | UPSERT or DELETE |
The type of action this message describes. One of UPSERT or DELETE. Please note: that the DELETE action type will not remove the object from HubSpot, it will prevent it from syncing in the future. In addition, sync messages will not restore or recreate deleted object records with the same |
| changedAt | long |
Optional. The epoch millisecond timestamp when the change that this message describes occurred in your ecommerce system. Providing this value is optional, but strongly recommended. If not provided, the time the message was received by HubSpot will be used instead. |
| properties | Map |
Map of external property names and values for this object. These are the values that we will sync into the corresponding HubSpot object. Please note: Once created with a sync message, a Contacts email property cannot be updated with an additional sync message. |
| associations | Map |
Map of associated object type to associated external IDs. |
