Documentation Updates - August 7, 2019: CRM Objects API and Ecommerce Bridge

[zwolfson]

We've recently made updates to some of our documentation to reflect some missing or incorrect functionality.  For all of these updates, no functionality is actually changing at this time, only the documentation has been updated with correct information.

CRM Objects API and the propertiesWithHistory parameter

For the Tickets, Products, and Line Items APIs, the propertiesWithHistory parameter is now supported when pulling these records. This parameter can be included in the request URL to pull the current and historical values for the specified property, and works the same as the already documented parameter from the Companies API.

The following documentation pages have been updated to include support for the propertiesWithHistory parameter:

https://developers.hubspot.com/docs/methods/tickets/get-all-tickets

https://developers.hubspot.com/docs/methods/tickets/get_ticket_by_id

https://developers.hubspot.com/docs/methods/tickets/get-batch-tickets-by-id

https://developers.hubspot.com/docs/methods/products/get-all-products

https://developers.hubspot.com/docs/methods/products/get_product_by_id

https://developers.hubspot.com/docs/methods/products/batch-get-products

https://developers.hubspot.com/docs/methods/line-items/get-all-line-items

https://developers.hubspot.com/docs/methods/line-items/get_line_item_by_id

https://developers.hubspot.com/docs/methods/line-items/batch-get-line-items

Ecommerce Bridge and sync errors

The "GET /extensions/ecomm/v2/sync/errors/portal" endpoint for the Ecommerce Bridge V2 previously indicated that it could be used with an OAuth Access token to get the sync errors for the specific HubSpot account from the specific app associated with the access token. This was incorrect, as the endpoint only supports custom integrations using API keys.

We've released a separate endpoint that does have the ability to use an OAuth access token, that will let you get the sync errors for a specific account from a specific app that is associated with the provided access token:

https://developers.hubspot.com/docs/methods/ecommerce/v2/get-all-sync-errors-for-an-app-and-account

Marketing Email API and the workflowNames field

When getting the details or statistics for a specific email, a field named workflowNames was previously returned. This field would only be set to an empty list, and as a result was removed from the response.

The following documentation pages have been updated to reflect that the field is no longer included in the response:

https://developers.hubspot.com/docs/methods/cms_email/get-the-statistics-for-a-marketing-email

https://developers.hubspot.com/docs/methods/cms_email/get-the-details-for-a-marketing-email

As mentioned above, no functionality is actually changing at this time, these are only documentation updates being made to reflect current functionality.

If you have any questions, join the conversation here.