|
1 | 1 | # Changelog |
2 | 2 | All notable changes to this project will be documented in this file. |
3 | 3 |
|
| 4 | +## [7.0.0] - revision 2023-10-15 |
| 5 | + |
| 6 | +### Added |
| 7 | + |
| 8 | +#### Support for returning list suppressions via the [/profiles endpoint](https://developers.klaviyo.com/en/reference/get_profiles) |
| 9 | + |
| 10 | +We now support filtering on list suppression with the get profiles endpoint, which brings us to parity with v2 list suppression endpoint that was the previously recommended solution. |
| 11 | + |
| 12 | +Rules for suppression [filtering](https://developers.klaviyo.com/en/docs/filtering_): |
| 13 | + |
| 14 | +- You may not mix-and-match list and global filters |
| 15 | +- You may only specify a single date filter |
| 16 | +- You may or may not specify a reason |
| 17 | +- You must specify a list_id to filter on any list suppression properties |
| 18 | + |
| 19 | +Examples: |
| 20 | + |
| 21 | +``` |
| 22 | +{filter: 'greater-than(subscriptions.email.marketing.suppression.timestamp,2023-03-01T01:00:00Z)'} |
| 23 | +{filter: 'greater-than(subscriptions.email.marketing.list_suppressions.timestamp,2023-03-01T01:00:00Z),equals(subscriptions.email.marketing.list_suppressions.list_id,”LIST_ID”') |
| 24 | +{filter: 'greater-than(subscriptions.email.marketing.suppression.timestamp,2023-03-01T01:00:00Z),equals(subscriptions.email.marketing.suppression.reason,"user_suppressed"') |
| 25 | +``` |
| 26 | +##### Optionally retrieve subscription status on Get List Profiles, Get Segment Profiles, Get Event Profile |
| 27 | +Now you can retrieve subscription status on any endpoint that returns profiles, including `getListProfiles`, `getSegmentProfiles` and `getEventProfile`. Use `{additionalFieldsProfile: ['subscriptions']}` on these endpoints to include subscription information. |
| 28 | + |
| 29 | +### Breaking changes |
| 30 | + |
| 31 | +#### Subscription object not returned by default on Get Profile / Get Profiles |
| 32 | + |
| 33 | +The subscription object is no longer returned by default with get profile(s) requests. However, it can be included by adding `?additional-fields[profile]=subscriptions` to the request. This change will allow us to provide a more performant experience when making requests to `GetProfiles` without including the subscriptions object. |
| 34 | + |
| 35 | +#### Profile Subscription Fields Renamed |
| 36 | + |
| 37 | +In the interest of providing more clarity and information on the subscription object, we have renamed several fields, and added several as well. This will provide more context on a contact's subscriptions and consent, as well as boolean fields to see who you can or cannot message. |
| 38 | + |
| 39 | +For SMSMarketing: |
| 40 | + |
| 41 | +- `timestamp` is now `consentTimestamp` |
| 42 | +- `lastUpdated` is a new field that mirrors `consenTimestamp` |
| 43 | +- `canReceiveSmsMarketing` is a new field which is `True` if the profile is consented for SMS |
| 44 | + |
| 45 | +For EmailMarketing: |
| 46 | + |
| 47 | +- `timestamp` is now `consentTimestamp` |
| 48 | +- `canReceiveEmailMarketing` is True if the profile does not have a global suppression |
| 49 | +- `suppressions` is now `suppression` |
| 50 | +- `lastUpdated` is a new field that is the most recent of all the dates on the object |
| 51 | + |
4 | 52 | ## [6.0.1] - revision 2023-09-15 |
5 | 53 | ### Fixed |
6 | 54 | - `Relationship` and its child attributes were incorrectly marked as optional for the following endpoints |
|
0 commit comments