All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Accounts API is now available, this will allow you to access information about the Klaviyo account associated with your API key.
get_accounts
get_account
Note: You will need to generate a new API key with either the Accounts
scope enabled or Full Access
to use these endpoints.
- All
client
endpointscreate_client_event
create_client_profile
create_client_subscription
- Profiles API now returns predictive analytics when calling
get_profile
andget_profiles
by passing inadditional_fields_profile: ["predictive_analytics"]
.
- Relationship endpoints that were previously grouped together are now split into related-resource-specific endpoints.
- To migrate to this latest version, all calls to relationship endpoints need to be updated, as in the following example:
get_campaign_relationships(id, "tags")
will becomeget_campaign_relationships_tags(id)
.
- Campagins (which were previously in our Beta API/SDKs)
- Profiles
- Fix longitude value in ProfileLocation type mapping
- Flows
- Pagination changed from page offset to cursor
- Added the following endpoints (which were previously in our Beta API/SDKs):
- Data Privacy
- All Tags endpoints, as well as the following related resource-specific endpoints:
- Get Flow Tags
- Get List Tags
- Get Segment Tags
- Support for cursor pagination
- Passing the
next
value from a paginated result to the following call via thepage_cursor
query string argument will now result in the cursor being parsed and set appropriately by theApiClient
.
- Passing the
- Initial release
- Naming changes:
- Package name: klaviyo_sdk -> klaviyo-api-sdk
- Module name: KlaviyoBeta -> KlaviyoAPI
- Some functions have changed name
- New resources and endpoints:
- See API Changelog for full details