Parameter |
Label |
Required |
Options |
Description |
ListId |
List Id |
YES |
|
The ID of the list for which you like to perform this operation.
|
email_type |
Email Type |
NO |
Option |
Value |
html |
html |
text |
text |
|
The email type.
|
status |
Status |
NO |
Option |
Value |
subscribed |
subscribed |
unsubscribed |
unsubscribed |
cleaned |
cleaned |
pending |
pending |
transactional |
transactional |
archived |
archived |
|
The subscriber's status. Possible values: subscribed, unsubscribed, cleaned, pending, transactional, or archived.
|
since_timestamp_opt |
Since Timestamp Opt (Format: 2015-10-21T15:41:36) |
NO |
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
|
Restrict results to subscribers who opted-in after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
|
before_timestamp_opt |
Before Timestamp Opt (Format: 2015-10-21T15:41:36) |
NO |
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
|
Restrict results to subscribers who opted-in before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
|
since_last_changed |
Since Last Changed (Format: 2015-10-21T15:41:36) |
NO |
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
|
Restrict results to subscribers whose information changed after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
|
before_last_changed |
Before Last Changed (Format: 2015-10-21T15:41:36) |
NO |
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
|
Restrict results to subscribers whose information changed before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
|
unique_email_id |
Unique Email Id |
NO |
|
A unique identifier for the email address across all Mailchimp lists.
|
vip_only |
VIP Only |
NO |
Option |
Value |
true |
true |
false |
false |
|
A filter to return only the list's VIP members. Passing true will restrict results to VIP list members, passing false will return all list members.
|
interest_category_id |
Interest Category Id |
NO |
|
The unique id for the interest category.
|
interest_ids |
Interest Ids |
NO |
|
Used to filter list members by interests. Must be accompanied by interest_category_id and interest_match. The value must be a comma separated list of interest ids present for any supplied interest categories.
|
interest_match |
Interest Match |
NO |
|
Used to filter list members by interests. Must be accompanied by interest_category_id and interest_ids. 'any' will match a member with any of the interest supplied, 'all' will only match members with every interest supplied, and 'none' will match members without any of the interest supplied. Possible values: 'any', 'all', or 'none'.
|
since_last_campaign |
Since Last Campaign |
NO |
Option |
Value |
true |
true |
false |
false |
|
Filter subscribers by those subscribed/unsubscribed/pending/cleaned since last email campaign send. Member status is required to use this filter.
|
unsubscribed_since |
Unsubscribed Since (Format: 2015-10-21T15:41:36) |
NO |
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
|
Filter subscribers by those unsubscribed since a specific date. Using any status other than unsubscribed with this filter will result in an error.
|