Get sync errors

GET /extensions/ecomm/v1/sync-errors

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing & CRM

Get errors from previously processed sync messages.

Errors are tracked by the integratorObjectId. Only the most recent error will be included for each integratorObjectId, and a successful sync for a given integratorObjectId will mark the error as resolved.

Note: If you are working with an installed app using OAuth, you must use the OAuth access token for a HubSpot account that the app is installed in. If you want to see all errors for your app, across all installed accounts, use the endpoint documented here.
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.

Optional Parameters How to use Description
Include resolved errors showResolvedErrors=
Used in the request URL
Whether or not to include resolved errors in the response. Defaults to false.
Error type  errorType=
Used in the request URL

Filter the results to the specified error type.

Must be one of:

  • INACTIVE_PORTAL
  • NO_SYNC_SETTINGS
  • SETTINGS_NOT_ENABLED
  • NO_MAPPINGS_DEFINED
  • MISSING_REQUIRED_PROPERTY
  • NO_PROPERTIES_DEFINED
  • INVALID_ASSOCIATION_PROPERTY
  • INVALID_DEAL_STAGE
  • INVALID_EMAIL_ADDRESS
  • INVALID_ENUM_PROPERTY
  • UNKNOWN_ERROR
Object Type

objectType=
Used in the request URL 

Filter the results to the specific object type.

Must be one of:

  • CONTACT,
  • DEAL
  • PRODUCT
  • LINE_ITEM
     
Limit limit=
Used in the request URL
The number of errors returned. Defaults to the maximum of 200.
Offset offset=
Used in the request URL
The index of the first error to be returned.