Send ecommerce sync messages

Last updated June 17, 2020

PUT /extensions/ecomm/v1/sync-messages/:object_type

Method Details

HTTP Methods:


Content Type:


Response Format:


Requires Authentication?


Rate Limited?





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 /:object_type
Used in the request URL
The object type that the updates are for. One of CONTACT, DEAL, PRODUCT, or LINE_ITEM.

The request will be a list of sync messages. Each message must include the following fields.

Field name  Field type Description
integratorObjectId String, max length 100 characters, ascii-only The ID, in your system, of the object that is being created, updated, or deleted.
action String The type of action this message describes. One of UPSERT or DELETE.
changeOccurredTimestamp long

A millisecond timestamp representing when the change that this message describes occurred.

Note: For object properties with existing values, values will only be updated if the changeOccurredTimestamp is more recent than the latest update to the property.

propertyNameToValues Map/Dictionary

This is a map of your property names to the values for this object. These are the values that we will sync into corresponding HubSpot object.

Each entry should have the format:
"{property name}" : "{property value}"
See the example for details.

The property values included should match the format that would be used for the mapped property. For example, when sending a datetime property for a contact property, the value should be a millisecond timestamp.