Migration strategy

🚧

v1/v2 legacy APIs are scheduled to retire on June 30, 2024.

Users of Klaviyo's v1/v2 APIs have until June 30, 2024 to migrate to our new APIs. At this time, our v1/v2 APIs will officially be retired. To learn more about Klaviyo’s API lifecycle, check out our updated API versioning and deprecation policy.

With Klaviyo’s new APIs, we’ve added improvements to our API functionality, new endpoints, and new features to some of our existing endpoints. Some general improvements include:

• All endpoints implement JSON:API which provides a standardized pattern for querying multiple, related objects in a single API request (e.g., fetching profiles that have been created after a specified date).
• All endpoints have been vetted to ensure adherence to consistent URL, request, and response syntactical standards.
• The URL topology has been reorganized to promote strong-typing, clear resource separation, and consistency with the Klaviyo UI (see comparison chart).
• There are explicitly-documented rate limits for all endpoints with standard, informative HTTP headers for retry control-flow.

Additionally, we’ve added several new endpoints improving our APIs, either by replacing and enhancing existing functionality or expanding our APIs with exciting, new endpoints. Some of these new APIs include, but are not limited to:

• Bulk Profile Import API

  Our Profiles API now has support for creating and updating profiles via Spawn Bulk Profile Import Job. To learn more, see our Bulk Profile Import guide.

• Coupons API

  Create coupons and coupon codes for use in messaging, view the coupons and coupon codes in your account, and create bulk jobs for coupon codes via our Coupons API.

• Flows API

  Fetch flows, update flow statuses, and access related objects for flows via our Flows API.

• Images API

  Upload new images to your account from an image file, retrieve one or more images from your account, and update an existing image's name and/or status with our Images API.

• Reporting API

  Use our new Reporting API to query the same service that powers the Klaviyo app to get 1:1 matches of your campaign and flow data.

Not a developer? Here's what to do

If you’ve received communications about your account(s) using legacy v1/v2 APIs, there are still some actions you need to take before June 30th. The table below includes the most common ways Klaviyo accounts are interacting with legacy APIs and our recommended actions for each scenario.

If you are unsure whether or not any of the following apply to you, we recommend taking a few minutes to audit your API usage. The report generated by Klaviyo’s API audit tool will give you more insight into how your account is interacting with legacy APIs so you can determine your next steps.

You can also read through our user FAQs for more information.

Next steps for developers

If you're a developer, follow any of the steps below that apply to your account:

Developer migration resources

We have migration-specific and general API tools and guides that will help you through your migration process. Consult the resources below for more information:

• Audit your API usage

  Quickly identify what legacy API calls your code is making with our API audit tool, and learn more about our API monitoring tools.

• Comparison chart: v1/v2 to new endpoints

  Map v1/v2 endpoints directly to their new endpoint equivalents, and review supported feature changes for each endpoint.

• Best practices for migrating from v1/v2 to new APIs

  Learn best practices in migrating several core use cases with solutions that are more optimal than drop-in endpoint replacements.

• Partner FAQs: v1/v2 retirement

  Find answers to common Klaviyo partner questions around the v1/v2 retirement.

📘

If you haven't already, join our Developer Community and sign up for our developer newsletter for additional support.

Additional resources

• API versioning and deprecation policy
• Changelog
• JSON:API feature guides
• Use Klaviyo's Postman collections