Legacy v1 Integration Timeline API Update
We are making an important update to ensure our platform remains cutting-edge and to facilitate the introduction of new features. Starting December 2, 2024, the legacy v1 Integration Timeline API will no longer support mutations of Timeline Events. This means the PUT method will no longer be supported, and users who currently modify events will need to update their migrations.
We highly recommend transitioning to the v3 Timeline Events API. This updated API is specifically designed to meet the changing needs of developers, with features tailored to modern integrations, including list segmentation and workflows specific to contact-based events. However, it's important to note that custom reports created using custom Timeline Events are not currently supported.
More information regarding this change can be found below.
What's changing?
Discontinuation of PUT Method for Creating Events:
- The PUT method for creating Timeline Events in the v1 API will be discontinued.
- Users must use the POST method or migrate to the v3 API.
Introduction of POST Method:
- A POST method will be introduced for sending Timeline Events in the v1 API.
Handling Existing Event IDs:
- POSTs and PUTs with existing EventIds will no longer be supported.
- Attempts to use existing EventIds will result in a
400
server error post-sunset date.
What does this mean for developers?
Users can migrate to the v3 Timeline Events API for enhanced features and support. Otherwise, users should update their API calls from PUT to POST to create new Timeline Events in the v1 Integration Timeline API.
Therefore, users currently utilizing the PUT method should:
- Immediately begin transitioning to the POST method for new events.
- Plan and execute migration to the v3 API before sunset to avoid disruptions.
If you have any inquiries or concerns, please contact us via the Developer Slack channel, #v1-timeline-api-change-2024.