Skip to main content
Server path: /mailchimp-audiences | Type: Application | PCID required: Yes

Tools

ToolDescription
mailchimp_audiences_create_audience_contactAdd Contact
mailchimp_audiences_delete_lists_idDelete list
mailchimp_audiences_delete_lists_id_members_idArchive list member
mailchimp_audiences_delete_lists_id_merge_fields_idDelete merge field
mailchimp_audiences_delete_lists_id_segments_idDelete segment
mailchimp_audiences_delete_lists_id_segments_id_members_idRemove list member from segment
mailchimp_audiences_get_audience_contactGet Contact
mailchimp_audiences_get_audience_contact_listGet Contacts
mailchimp_audiences_get_audience_contactsGet a list of audiences
mailchimp_audiences_get_audience_idGet audience info
mailchimp_audiences_get_list_member_tagsList member tags
mailchimp_audiences_get_listsGet lists info
mailchimp_audiences_get_lists_idGet list info
mailchimp_audiences_get_lists_id_activityList recent activity
mailchimp_audiences_get_lists_id_membersList members info
mailchimp_audiences_get_lists_id_members_idGet member info
mailchimp_audiences_get_lists_id_members_id_eventsList member events
mailchimp_audiences_get_lists_id_merge_fieldsList merge fields
mailchimp_audiences_get_lists_id_merge_fields_idGet merge field
mailchimp_audiences_get_lists_id_segments_idGet segment info
mailchimp_audiences_get_lists_id_segments_id_membersList members in segment
mailchimp_audiences_get_search_membersSearch members
mailchimp_audiences_patch_audience_contactUpdate Contact
mailchimp_audiences_patch_lists_idUpdate lists
mailchimp_audiences_patch_lists_id_members_idUpdate list member
mailchimp_audiences_patch_lists_id_merge_fields_idUpdate merge field
mailchimp_audiences_patch_lists_id_segments_idUpdate segment
mailchimp_audiences_post_contacts_actions_archiveArchive Contact
mailchimp_audiences_post_contacts_actions_forgetForget Contact
mailchimp_audiences_post_list_member_eventsAdd event
mailchimp_audiences_post_list_member_tagsAdd or remove member tags
mailchimp_audiences_post_listsAdd list
mailchimp_audiences_post_lists_idBatch subscribe or unsubscribe
mailchimp_audiences_post_lists_id_membersAdd member to list
mailchimp_audiences_post_lists_id_members_hash_actions_delete_permanentDelete list member
mailchimp_audiences_post_lists_id_merge_fieldsAdd merge field
mailchimp_audiences_post_lists_id_segmentsAdd segment
mailchimp_audiences_post_lists_id_segments_idBatch add or remove members
mailchimp_audiences_post_lists_id_segments_id_membersAdd member to segment
mailchimp_audiences_post_lists_id_surveys_id_actions_create_emailCreate a Survey Campaign
mailchimp_audiences_post_lists_id_surveys_id_actions_publishPublish a Survey
mailchimp_audiences_post_lists_id_surveys_id_actions_unpublishUnpublish a Survey
mailchimp_audiences_preview_asegmentList segments
mailchimp_audiences_put_lists_id_members_idAdd or update list member
mailchimp_audiences_search_tags_by_nameSearch for tags on a list by name.

mailchimp_audiences_create_audience_contact

Add Contact Parameters:
ParameterTypeRequiredDefaultDescription
audience_idstringYesThe unique ID for the audience.
merge_field_validation_modestringNoDefines how merge field validation is handled. When set to ignore_required_checks, the API does not raise an error if required merge fields are missing from the request. When set to strict, the API enforces validation and returns an error if any required merge field is not provided. If this setting is omitted, strict is applied by default.
data_modestringNoIndicates the data processing mode. In historical mode, contact data changes do not trigger automations or webhooks. In live mode, such changes do trigger them.
email_channelobjectNoEmail Channel
languagestringNoThe subscribers detected language.
merge_fieldsobjectNoA dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure.
sms_channelobjectNoSms Channel
tagsstring[]NoAn array of tag names to add to the contact. This operation is append-only; existing tags will be preserved, and only new tags from this array will be added.

mailchimp_audiences_delete_lists_id

Delete list Parameters:
ParameterTypeRequiredDefaultDescription
list_idstringYesThe unique ID for the list.

mailchimp_audiences_delete_lists_id_members_id

Archive list member Parameters:
ParameterTypeRequiredDefaultDescription
list_idstringYesThe unique ID for the list.
subscriber_hashstringYesThe MD5 hash of the lowercase version of the list member’s email address. This endpoint also accepts a list member’s email address or contact_id.

mailchimp_audiences_delete_lists_id_merge_fields_id

Delete merge field Parameters:
ParameterTypeRequiredDefaultDescription
list_idstringYesThe unique ID for the list.
merge_idstringYesThe id for the merge field.

mailchimp_audiences_delete_lists_id_segments_id

Delete segment Parameters:
ParameterTypeRequiredDefaultDescription
list_idstringYesThe unique ID for the list.
segment_idstringYesThe unique id for the segment.

mailchimp_audiences_delete_lists_id_segments_id_members_id

Remove list member from segment Parameters:
ParameterTypeRequiredDefaultDescription
list_idstringYesThe unique ID for the list.
segment_idstringYesThe unique id for the segment.
subscriber_hashstringYesThe MD5 hash of the lowercase version of the list member’s email address.

mailchimp_audiences_get_audience_contact

Get Contact Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
audience_idstringYesThe unique ID for the audience.
contact_idstringYesA unique identifier for the contact, which can be a Mailchimp contact ID or a channel hash. A channel hash must follow the format email:[md5_hash] (where the hash is the MD5 of the lowercased email address) or sms:[sha256_hash] (where the hash is the SHA256 of the E.164-formatted phone number).

mailchimp_audiences_get_audience_contact_list

Get Contacts Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
countintegerNoThe number of records to return. Default value is 10. Maximum value is 1000
cursorstringNoPaginate through a collection of records by setting the cursor parameter to a next_cursor attribute returned by a previous request. Default value fetches the first “page” of results.
created_beforestringNoRestricts the response to contacts created at or before the specified time (inclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00.
created_sincestringNoRestricts the response to contacts created after the specified time (exclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00.
updated_beforestringNoRestricts the response to contacts updated at or before the specified time (inclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00.
updated_sincestringNoRestricts the response to contacts updated after the specified time (exclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00.
audience_idstringYesThe unique ID for the audience.
sort_fieldstringNoSpecifies the field to sort the returned contacts by.
sort_dirstringNoDetermines the order direction for sorted results.

mailchimp_audiences_get_audience_contacts

Get a list of audiences Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
countintegerNoThe number of records to return. Default value is 10. Maximum value is 1000
offsetintegerNoUsed for pagination, this is the number of records from a collection to skip. Default value is 0.

mailchimp_audiences_get_audience_id

Get audience info Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
audience_idstringYesThe unique ID for the audience.

mailchimp_audiences_get_list_member_tags

List member tags Parameters:
ParameterTypeRequiredDefaultDescription
list_idstringYesThe unique ID for the list.
subscriber_hashstringYesThe MD5 hash of the lowercase version of the list member’s email address. This endpoint also accepts a list member’s email address or contact_id.
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
countintegerNoThe number of records to return. Default value is 10. Maximum value is 1000
offsetintegerNoUsed for pagination, this is the number of records from a collection to skip. Default value is 0.

mailchimp_audiences_get_lists

Get lists info Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
countintegerNoThe number of records to return. Default value is 10. Maximum value is 1000
offsetintegerNoUsed for pagination, this is the number of records from a collection to skip. Default value is 0.
before_date_createdstringNoRestrict response to lists created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
since_date_createdstringNoRestrict results to lists created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
before_campaign_last_sentstringNoRestrict results to lists created before the last campaign send date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
since_campaign_last_sentstringNoRestrict results to lists created after the last campaign send date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
emailstringNoRestrict results to lists that include a specific subscriber’s email address.
sort_fieldstringNoReturns files sorted by the specified field.
sort_dirstringNoDetermines the order direction for sorted results.
has_ecommerce_storebooleanNoRestrict results to lists that contain an active, connected, undeleted ecommerce store.
include_total_contactsbooleanNoReturn the total_contacts field in the stats response, which contains an approximate count of all contacts in any state.

mailchimp_audiences_get_lists_id

Get list info Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
list_idstringYesThe unique ID for the list.
include_total_contactsbooleanNoReturn the total_contacts field in the stats response, which contains an approximate count of all contacts in any state.

mailchimp_audiences_get_lists_id_activity

List recent activity Parameters:
ParameterTypeRequiredDefaultDescription
countintegerNoThe number of records to return. Default value is 10. Maximum value is 1000
offsetintegerNoUsed for pagination, this is the number of records from a collection to skip. Default value is 0.
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
list_idstringYesThe unique ID for the list.

mailchimp_audiences_get_lists_id_members

List members info Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
countintegerNoThe number of records to return. Default value is 10. Maximum value is 1000
offsetintegerNoUsed for pagination, this is the number of records from a collection to skip. Default value is 0.
list_idstringYesThe unique ID for the list.
email_typestringNoThe email type.
statusstringNoThe subscriber’s status.
since_timestamp_optstringNoRestrict results to subscribers who opted-in after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
before_timestamp_optstringNoRestrict results to subscribers who opted-in before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
since_last_changedstringNoRestrict results to subscribers whose information changed after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
before_last_changedstringNoRestrict results to subscribers whose information changed before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
unique_email_idstringNoA unique identifier for the email address across all Mailchimp lists.
vip_onlybooleanNoA 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_idstringNoThe unique id for the interest category.
interest_idsstringNoUsed 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_matchstringNoUsed 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.
sort_fieldstringNoReturns files sorted by the specified field.
sort_dirstringNoDetermines the order direction for sorted results.
since_last_campaignbooleanNoFilter subscribers by those subscribed/unsubscribed/pending/cleaned since last email campaign send. Member status is required to use this filter.
unsubscribed_sincestringNoFilter subscribers by those unsubscribed since a specific date. Using any status other than unsubscribed with this filter will result in an error.

mailchimp_audiences_get_lists_id_members_id

Get member info Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
list_idstringYesThe unique ID for the list.
subscriber_hashstringYesThe MD5 hash of the lowercase version of the list member’s email address. This endpoint also accepts a list member’s email address or contact_id.

mailchimp_audiences_get_lists_id_members_id_events

List member events Parameters:
ParameterTypeRequiredDefaultDescription
list_idstringYesThe unique ID for the list.
subscriber_hashstringYesThe MD5 hash of the lowercase version of the list member’s email address. This endpoint also accepts a list member’s email address or contact_id.
countintegerNoThe number of records to return. Default value is 10. Maximum value is 1000
offsetintegerNoUsed for pagination, this is the number of records from a collection to skip. Default value is 0.
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

mailchimp_audiences_get_lists_id_merge_fields

List merge fields Parameters:
ParameterTypeRequiredDefaultDescription
list_idstringYesThe unique ID for the list.
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
countintegerNoThe number of records to return. Default value is 10. Maximum value is 1000
offsetintegerNoUsed for pagination, this is the number of records from a collection to skip. Default value is 0.
typestringNoThe merge field type.
requiredbooleanNoWhether it’s a required merge field.

mailchimp_audiences_get_lists_id_merge_fields_id

Get merge field Parameters:
ParameterTypeRequiredDefaultDescription
list_idstringYesThe unique ID for the list.
merge_idstringYesThe id for the merge field.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

mailchimp_audiences_get_lists_id_segments_id

Get segment info Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
list_idstringYesThe unique ID for the list.
segment_idstringYesThe unique id for the segment.
include_cleanedbooleanNoInclude cleaned members in response
include_transactionalbooleanNoInclude transactional members in response
include_unsubscribedbooleanNoInclude unsubscribed members in response

mailchimp_audiences_get_lists_id_segments_id_members

List members in segment Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
countintegerNoThe number of records to return. Default value is 10. Maximum value is 1000
offsetintegerNoUsed for pagination, this is the number of records from a collection to skip. Default value is 0.
list_idstringYesThe unique ID for the list.
segment_idstringYesThe unique id for the segment.
include_cleanedbooleanNoInclude cleaned members in response
include_transactionalbooleanNoInclude transactional members in response
include_unsubscribedbooleanNoInclude unsubscribed members in response

mailchimp_audiences_get_search_members

Search members Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
querystringYesThe search query used to filter results. Query should be a valid email, or a string representing a contact’s first or last name.
list_idstringNoThe unique id for the list.

mailchimp_audiences_patch_audience_contact

Update Contact Parameters:
ParameterTypeRequiredDefaultDescription
audience_idstringYesThe unique ID for the audience.
contact_idstringYesThe unique id for the contact.
merge_field_validation_modestringNoDefines how merge field validation is handled. When set to ignore_required_checks, the API does not raise an error if required merge fields are missing from the request. When set to strict, the API enforces validation and returns an error if any required merge field is not provided. If this setting is omitted, strict is applied by default.
data_modestringNoIndicates the data processing mode. In historical mode, contact data changes do not trigger automations or webhooks. In live mode, such changes do trigger them.
email_channelobjectNoEmail Channel
languagestringNoThe subscribers detected language.
merge_fieldsobjectNoA dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure.
sms_channelobjectNoSms Channel
tagsstring[]NoAn array of tag names to add to the contact. This operation is append-only; existing tags will be preserved, and only new tags from this array will be added.

mailchimp_audiences_patch_lists_id

Update lists Parameters:
ParameterTypeRequiredDefaultDescription
list_idstringYesThe unique ID for the list.
campaign_defaultsobjectNoDefault values for campaigns created for this list.
contactobjectNoContact information displayed in campaign footers to comply with international spam laws.
double_optinbooleanNoWhether or not to require the subscriber to confirm subscription via email.
email_type_optionbooleanNoWhether the list supports multiple formats for emails. When set to true, subscribers can choose whether they want to receive HTML or plain-text emails. When set to false, subscribers will receive HTML emails, with a plain-text alternative backup.
marketing_permissionsbooleanNoWhether or not the list has marketing permissions (eg. GDPR) enabled.
namestringNoThe name of the list.
notify_on_subscribestringNoThe email address to send subscribe notifications to.
notify_on_unsubscribestringNoThe email address to send unsubscribe notifications to.
permission_reminderstringNoThe permission reminder for the list.
use_archive_barbooleanNoWhether campaigns for this list use the Archive Bar in archives by default.

mailchimp_audiences_patch_lists_id_members_id

Update list member Parameters:
ParameterTypeRequiredDefaultDescription
list_idstringYesThe unique ID for the list.
subscriber_hashstringYesThe MD5 hash of the lowercase version of the list member’s email address. This endpoint also accepts a list member’s email address or contact_id.
skip_merge_validationbooleanNoIf skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false.
email_addressstringNoEmail address for a subscriber.
email_typestringNoType of email this member asked to get (‘html’ or ‘text’).
interestsobjectNoThe key of this object’s properties is the ID of the interest in question.
ip_optstringNoThe IP address the subscriber used to confirm their opt-in status.
ip_signupstringNoIP address the subscriber signed up from.
languagestringNoIf set/detected, the subscriber’s language.
locationobjectNoSubscriber location information.
marketing_permissionsobject[]NoThe marketing permissions for the subscriber.
merge_fieldsobjectNoA dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure.
statusstringNoSubscriber’s current status.
timestamp_optstringNoThe date and time the subscriber confirmed their opt-in status in ISO 8601 format.
timestamp_signupstringNoThe date and time the subscriber signed up for the list in ISO 8601 format.
vipbooleanNoVIP status for subscriber.

mailchimp_audiences_patch_lists_id_merge_fields_id

Update merge field Parameters:
ParameterTypeRequiredDefaultDescription
list_idstringYesThe unique ID for the list.
merge_idstringYesThe id for the merge field.
default_valuestringNoThe default value for the merge field if null.
display_orderintegerNoThe order that the merge field displays on the list signup form.
help_textstringNoExtra text to help the subscriber fill out the form.
namestringNoThe name of the merge field (audience field).
optionsobjectNoExtra options for some merge field types.
publicbooleanNoWhether the merge field is displayed on the signup form.
requiredbooleanNoWhether the merge field is required to import a contact.
tagstringNoThe merge tag used for Mailchimp campaigns and adding contact information.

mailchimp_audiences_patch_lists_id_segments_id

Update segment Parameters:
ParameterTypeRequiredDefaultDescription
list_idstringYesThe unique ID for the list.
segment_idstringYesThe unique id for the segment.
namestringNoThe name of the segment.
optionsobjectNoThe conditions of the segment. Static and fuzzy segments don’t have conditions.
static_segmentstring[]NoAn array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. Passing an empty array for an existing static segment will reset that segment and remove all members. This field cannot be provided with the options field.

mailchimp_audiences_post_contacts_actions_archive

Archive Contact Parameters:
ParameterTypeRequiredDefaultDescription
audience_idstringYesThe unique ID for the audience.
contact_idstringYesThe unique id for the contact.

mailchimp_audiences_post_contacts_actions_forget

Forget Contact Parameters:
ParameterTypeRequiredDefaultDescription
audience_idstringYesThe unique ID for the audience.
contact_idstringYesThe unique id for the contact.

mailchimp_audiences_post_list_member_events

Add event Parameters:
ParameterTypeRequiredDefaultDescription
list_idstringYesThe unique ID for the list.
subscriber_hashstringYesThe MD5 hash of the lowercase version of the list member’s email address. This endpoint also accepts a list member’s email address or contact_id.
is_syncingbooleanNoEvents created with the is_syncing value set to true will not trigger automations.
namestringYesThe name for this type of event (‘purchased’, ‘visited’, etc). Must be 2-30 characters in length
occurred_atstringNoThe date and time the event occurred in ISO 8601 format.
propertiesobjectNoAn optional list of properties

mailchimp_audiences_post_list_member_tags

Add or remove member tags Parameters:
ParameterTypeRequiredDefaultDescription
list_idstringYesThe unique ID for the list.
subscriber_hashstringYesThe MD5 hash of the lowercase version of the list member’s email address.
is_syncingbooleanNoWhen is_syncing is true, automations based on the tags in the request will not fire
tagsobject[]YesA list of tags assigned to the list member.

mailchimp_audiences_post_lists

Add list Parameters:
ParameterTypeRequiredDefaultDescription
campaign_defaultsobjectYesDefault values for campaigns created for this list.
contactobjectYesContact information displayed in campaign footers to comply with international spam laws.
double_optinbooleanNoWhether or not to require the subscriber to confirm subscription via email.
email_type_optionbooleanYesWhether the list supports multiple formats for emails. When set to true, subscribers can choose whether they want to receive HTML or plain-text emails. When set to false, subscribers will receive HTML emails, with a plain-text alternative backup.
marketing_permissionsbooleanNoWhether or not the list has marketing permissions (eg. GDPR) enabled.
namestringYesThe name of the list.
notify_on_subscribestringNoThe email address to send subscribe notifications to.
notify_on_unsubscribestringNoThe email address to send unsubscribe notifications to.
permission_reminderstringYesThe permission reminder for the list.
use_archive_barbooleanNoWhether campaigns for this list use the Archive Bar in archives by default.

mailchimp_audiences_post_lists_id

Batch subscribe or unsubscribe Parameters:
ParameterTypeRequiredDefaultDescription
list_idstringYesThe unique ID for the list.
skip_merge_validationbooleanNoIf skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false.
skip_duplicate_checkbooleanNoIf skip_duplicate_check is true, we will ignore duplicates sent in the request when using the batch sub/unsub on the lists endpoint. The status of the first appearance in the request will be saved. This defaults to false.
membersobject[]YesAn array of objects, each representing an email address and the subscription status for a specific list. Up to 500 members may be added or updated with each API call.
sync_tagsbooleanNoWhether this batch operation will replace all existing tags with tags in request.
update_existingbooleanNoWhether this batch operation will change existing members’ subscription status.

mailchimp_audiences_post_lists_id_members

Add member to list Parameters:
ParameterTypeRequiredDefaultDescription
list_idstringYesThe unique ID for the list.
skip_merge_validationbooleanNoIf skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false.
email_addressstringYesEmail address for a subscriber.
email_typestringNoType of email this member asked to get (‘html’ or ‘text’).
interestsobjectNoThe key of this object’s properties is the ID of the interest in question.
ip_optstringNoThe IP address the subscriber used to confirm their opt-in status.
ip_signupstringNoIP address the subscriber signed up from.
languagestringNoIf set/detected, the subscriber’s language.
locationobjectNoSubscriber location information.
marketing_permissionsobject[]NoThe marketing permissions for the subscriber.
merge_fieldsobjectNoA dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure.
statusstringYesSubscriber’s current status.
tagsstring[]NoThe tags that are associated with a member.
timestamp_optstringNoThe date and time the subscriber confirmed their opt-in status in ISO 8601 format.
timestamp_signupstringNoThe date and time the subscriber signed up for the list in ISO 8601 format.
vipbooleanNoVIP status for subscriber.

mailchimp_audiences_post_lists_id_members_hash_actions_delete_permanent

Delete list member Parameters:
ParameterTypeRequiredDefaultDescription
list_idstringYesThe unique ID for the list.
subscriber_hashstringYesThe MD5 hash of the lowercase version of the list member’s email address.

mailchimp_audiences_post_lists_id_merge_fields

Add merge field Parameters:
ParameterTypeRequiredDefaultDescription
list_idstringYesThe unique ID for the list.
default_valuestringNoThe default value for the merge field if null.
display_orderintegerNoThe order that the merge field displays on the list signup form.
help_textstringNoExtra text to help the subscriber fill out the form.
namestringYesThe name of the merge field (audience field).
optionsobjectNoExtra options for some merge field types.
publicbooleanNoWhether the merge field is displayed on the signup form.
requiredbooleanNoWhether the merge field is required to import a contact.
tagstringNoThe merge tag used for Mailchimp campaigns and adding contact information.
typestringYesThe type for the merge field.

mailchimp_audiences_post_lists_id_segments

Add segment Parameters:
ParameterTypeRequiredDefaultDescription
list_idstringYesThe unique ID for the list.
namestringYesThe name of the segment.
optionsobjectNoThe conditions of the segment. Static and fuzzy segments don’t have conditions.
static_segmentstring[]NoAn array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. Passing an empty array will create a static segment without any subscribers. This field cannot be provided with the options field.

mailchimp_audiences_post_lists_id_segments_id

Batch add or remove members Parameters:
ParameterTypeRequiredDefaultDescription
list_idstringYesThe unique ID for the list.
segment_idstringYesThe unique id for the segment.
members_to_addstring[]NoAn array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. A maximum of 500 members can be sent.
members_to_removestring[]NoAn array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. A maximum of 500 members can be sent.

mailchimp_audiences_post_lists_id_segments_id_members

Add member to segment Parameters:
ParameterTypeRequiredDefaultDescription
list_idstringYesThe unique ID for the list.
segment_idstringYesThe unique id for the segment.
email_addressstringYesEmail address for a subscriber.

mailchimp_audiences_post_lists_id_surveys_id_actions_create_email

Create a Survey Campaign Parameters:
ParameterTypeRequiredDefaultDescription
list_idstringYesThe unique ID for the list.
survey_idstringYesThe ID of the survey.

mailchimp_audiences_post_lists_id_surveys_id_actions_publish

Publish a Survey Parameters:
ParameterTypeRequiredDefaultDescription
list_idstringYesThe unique ID for the list.
survey_idstringYesThe ID of the survey.

mailchimp_audiences_post_lists_id_surveys_id_actions_unpublish

Unpublish a Survey Parameters:
ParameterTypeRequiredDefaultDescription
list_idstringYesThe unique ID for the list.
survey_idstringYesThe ID of the survey.

mailchimp_audiences_preview_asegment

List segments Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
countintegerNoThe number of records to return. Default value is 10. Maximum value is 1000
offsetintegerNoUsed for pagination, this is the number of records from a collection to skip. Default value is 0.
list_idstringYesThe unique ID for the list.
typestringNoLimit results based on segment type.
since_created_atstringNoRestrict results to segments created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
before_created_atstringNoRestrict results to segments created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
include_cleanedbooleanNoInclude cleaned members in response
include_transactionalbooleanNoInclude transactional members in response
include_unsubscribedbooleanNoInclude unsubscribed members in response
since_updated_atstringNoRestrict results to segments update after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
before_updated_atstringNoRestrict results to segments update before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
exclude_typestringNoExclude results based on segment type. For example, use exclude_type=static to exclude tags from the response.

mailchimp_audiences_put_lists_id_members_id

Add or update list member Parameters:
ParameterTypeRequiredDefaultDescription
list_idstringYesThe unique ID for the list.
subscriber_hashstringYesThe MD5 hash of the lowercase version of the list member’s email address. This endpoint also accepts a list member’s email address or contact_id.
skip_merge_validationbooleanNoIf skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false.
email_addressstringYesEmail address for a subscriber. This value is required only if the email address is not already present on the list.
email_typestringNoType of email this member asked to get (‘html’ or ‘text’).
interestsobjectNoThe key of this object’s properties is the ID of the interest in question.
ip_optstringNoThe IP address the subscriber used to confirm their opt-in status.
ip_signupstringNoIP address the subscriber signed up from.
languagestringNoIf set/detected, the subscriber’s language.
locationobjectNoSubscriber location information.
marketing_permissionsobject[]NoThe marketing permissions for the subscriber.
merge_fieldsobjectNoA dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure.
statusstringNoSubscriber’s current status.
status_if_newstringYesSubscriber’s status. This value is required only if the email address is not already present on the list.
timestamp_optstringNoThe date and time the subscriber confirmed their opt-in status in ISO 8601 format.
timestamp_signupstringNoThe date and time the subscriber signed up for the list in ISO 8601 format.
vipbooleanNoVIP status for subscriber.

mailchimp_audiences_search_tags_by_name

Search for tags on a list by name. Parameters:
ParameterTypeRequiredDefaultDescription
list_idstringYesThe unique ID for the list.
namestringNoThe search query used to filter tags. The search query will be compared to each tag as a prefix, so all tags that have a name starting with this field will be returned.