Skip to content

Commit bbab41e

Browse files
Update CHANGELOG.md
1 parent 4fd2ebc commit bbab41e

1 file changed

Lines changed: 33 additions & 31 deletions

File tree

CHANGELOG.md

Lines changed: 33 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -5,49 +5,51 @@ All notable changes to this project will be documented in this file.
55

66
### Added
77

8-
#### Support for returning list suppressions via the [/profiles endpoint](https://developers.klaviyo.com/en/reference/get_profiles)
8+
- Support for returning list suppressions via the [/profiles endpoint](https://developers.klaviyo.com/en/reference/get_profiles)
99

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.
10+
Rules for suppression [filtering](https://developers.klaviyo.com/en/docs/filtering_):
1111

12-
Rules for suppression [filtering](https://developers.klaviyo.com/en/docs/filtering_):
12+
- You may not mix-and-match list and global filters
13+
- You may only specify a single date filter
14+
- You may or may not specify a reason
15+
- You must specify a list_id to filter on any list suppression properties
1316

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
17+
Examples:
1818

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.
19+
```
20+
{filter: 'greater-than(subscriptions.email.marketing.suppression.timestamp,2023-03-01T01:00:00Z)'}
21+
{filter: 'greater-than(subscriptions.email.marketing.list_suppressions.timestamp,2023-03-01T01:00:00Z),equals(subscriptions.email.marketing.list_suppressions.list_id,”LIST_ID”')
22+
{filter: 'greater-than(subscriptions.email.marketing.suppression.timestamp,2023-03-01T01:00:00Z),equals(subscriptions.email.marketing.suppression.reason,"user_suppressed"')
23+
```
24+
- Optionally retrieve subscription status on:
25+
- `getListProfiles`
26+
- `getSegmentProfiles`
27+
- `getEventProfile`
28+
29+
Use `{additionalFieldsProfile: ['subscriptions']}` on these endpoints to include subscription information.
2830

29-
### Breaking changes
31+
### Changed
3032

31-
#### Subscription object not returned by default on Get Profile / Get Profiles
33+
- Subscription object not returned by default on Get Profile / Get Profiles
3234

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.
35+
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.
3436

35-
#### Profile Subscription Fields Renamed
37+
- Profile Subscription Fields Renamed
3638

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.
39+
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.
3840

39-
For SMSMarketing:
41+
For SMSMarketing:
4042

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
43+
- `timestamp` is now `consentTimestamp`
44+
- `lastUpdated` is a new field that mirrors `consenTimestamp`
45+
- `canReceiveSmsMarketing` is a new field which is `True` if the profile is consented for SMS
4446

45-
For EmailMarketing:
47+
For EmailMarketing:
4648

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
49+
- `timestamp` is now `consentTimestamp`
50+
- `canReceiveEmailMarketing` is True if the profile does not have a global suppression
51+
- `suppressions` is now `suppression`
52+
- `lastUpdated` is a new field that is the most recent of all the dates on the object
5153

5254
## [6.0.1] - revision 2023-09-15
5355
### Fixed
@@ -208,4 +210,4 @@ In addition, you can [make client-side API calls](https://developers.klaviyo.com
208210
- Package name: klaviyo-sdk-beta → klaviyo-api
209211
- Some functions have changed name
210212
- New resources and endpoints:
211-
- See [API Changelog](https://developers.klaviyo.com/en/docs/changelog_) for full details
213+
- See [API Changelog](https://developers.klaviyo.com/en/docs/changelog_) for full details

0 commit comments

Comments
 (0)