For changes that have been updated across all version, see the Unversioned changes page.
Breaking Changes
This version of the API includes breaking changes.
Major changes include:
- Users API & Leads API are deprecated and replaced with Contacts API.
- Custom Data Attributes can only be created through the Data Attributes API. If you want to update a contact with an attribute that does not exist yet then you must create it through the Data Attributes API and update the contact afterwards.
We're excited to share that we've now launched a major update to our API - giving you more powerful, contextual, and intuitive access to your data:
- A new, strictly RESTful Contacts API that combines users and leads — collectively known as "contacts" — and enables you to search for the exact contacts you need by filtering using any combination of fields, like location or a custom NPS score. Plus, the API exposes new attributes, like
last_contactedandbrowser_version, and uses cursor-based pagination to give you access to all of your contacts without restrictions. - An updated Conversations API that enables you to tag conversations directly, search and retrieve conversations by any combination of fields, and access more granular attributes, like timestamps and out-of-the-box metrics such as
time_to_first_responseandmedian_time_to_reply. - A new Data Attributes API that lets you create and update custom data attributes, set a label and description for each, and build a dropdown list of defined attribute options. This means your app users can more easily leverage data when targeting and communicating with customers and leads.