Mailchimp

Mailchimp integration (Communication, Marketing). Imported from open-connector.

API key11 toolshttps://{dc}.api.mailchimp.com/3.0

GET

mailchimp_list_lists

List Mailchimp audiences/lists visible to the current API key.

/lists

2 parameters

Param	Type	Required	Description
count	integer	optional	Maximum number of items to return.
offset	integer	optional	Number of items to skip before collecting the response page.

GET

mailchimp_get_list

Fetch a single Mailchimp audience/list by ID.

/lists/{list_id}

1 parameter

Param	Type	Required	Description
list_id	string	required	Mailchimp audience/list identifier.

GET

mailchimp_list_members

List members in a Mailchimp audience/list.

/lists/{list_id}/members

4 parameters

Param	Type	Required	Description
list_id	string	required	Mailchimp audience/list identifier.
count	integer	optional	Maximum number of items to return.
offset	integer	optional	Number of items to skip before collecting the response page.
status	string	optional	Mailchimp member status value accepted by the official API.

GET

mailchimp_get_member

Fetch a single Mailchimp member by subscriber hash or email address.

/lists/{list_id}/members/{subscriber_hash}

3 parameters

Param	Type	Required	Description
list_id	string	required	Mailchimp audience/list identifier.
subscriber_hash	string	required	Lowercase MD5 hash of the subscriber email address accepted by Mailchimp.
email_address	string	optional	Subscriber email address used by Mailchimp to derive the subscriber hash.

PUT

mailchimp_upsert_member

Add or update a Mailchimp member using the official upsert endpoint.

/lists/{list_id}/members/{email_address}

9 parameters

Param	Type	Required	Description
list_id	string	required	Mailchimp audience/list identifier.
email_address	string	required	Subscriber email address used by Mailchimp to derive the subscriber hash.
status_if_new	string	optional	Mailchimp member status value accepted by the official API.
skip_merge_validation	boolean	optional	Whether Mailchimp should skip merge-field validation during the write request.
merge_fields	object	optional	Merge fields object accepted by the official Mailchimp API.
status	string	optional	Mailchimp member status value accepted by the official API.
vip	boolean	optional	Whether Mailchimp should mark the member as VIP.
language	string	optional	Preferred language code accepted by the official Mailchimp API.
email_type	string	optional	Email content type accepted by the official Mailchimp API.

PATCH

mailchimp_update_member

Patch an existing Mailchimp member by subscriber hash or email address.

/lists/{list_id}/members/{subscriber_hash}

9 parameters

Param	Type	Required	Description
list_id	string	required	Mailchimp audience/list identifier.
subscriber_hash	string	required	Lowercase MD5 hash of the subscriber email address accepted by Mailchimp.
email_address	string	optional	Subscriber email address used by Mailchimp to derive the subscriber hash.
skip_merge_validation	boolean	optional	Whether Mailchimp should skip merge-field validation during the write request.
merge_fields	object	optional	Merge fields object accepted by the official Mailchimp API.
status	string	optional	Mailchimp member status value accepted by the official API.
vip	boolean	optional	Whether Mailchimp should mark the member as VIP.
language	string	optional	Preferred language code accepted by the official Mailchimp API.
email_type	string	optional	Email content type accepted by the official Mailchimp API.

DELETE

mailchimp_archive_member

Archive a Mailchimp member from the specified audience/list.

/lists/{list_id}/members/{subscriber_hash}

3 parameters

Param	Type	Required	Description
list_id	string	required	Mailchimp audience/list identifier.
subscriber_hash	string	required	Lowercase MD5 hash of the subscriber email address accepted by Mailchimp.
email_address	string	optional	Subscriber email address used by Mailchimp to derive the subscriber hash.

POST

mailchimp_delete_member_permanently

Permanently delete a Mailchimp member from the specified audience/list.

/lists/{list_id}/members/{subscriber_hash}/actions/delete-permanent

3 parameters

Param	Type	Required	Description
list_id	string	required	Mailchimp audience/list identifier.
subscriber_hash	string	required	Lowercase MD5 hash of the subscriber email address accepted by Mailchimp.
email_address	string	optional	Subscriber email address used by Mailchimp to derive the subscriber hash.

GET

mailchimp_list_member_tags

List tags currently attached to a Mailchimp member.

/lists/{list_id}/members/{subscriber_hash}/tags

3 parameters

Param	Type	Required	Description
list_id	string	required	Mailchimp audience/list identifier.
subscriber_hash	string	required	Lowercase MD5 hash of the subscriber email address accepted by Mailchimp.
email_address	string	optional	Subscriber email address used by Mailchimp to derive the subscriber hash.

POST

mailchimp_update_member_tags

Add or remove Mailchimp member tags using the official tag-update endpoint.

/lists/{list_id}/members/{subscriber_hash}/tags

4 parameters

Param	Type	Required	Description
list_id	string	required	Mailchimp audience/list identifier.
subscriber_hash	string	required	Lowercase MD5 hash of the subscriber email address accepted by Mailchimp.
email_address	string	optional	Subscriber email address used by Mailchimp to derive the subscriber hash.
tags	array	required	Tag updates to submit to Mailchimp.

GET

mailchimp_list_merge_fields

List merge fields defined for a Mailchimp audience/list.

/lists/{list_id}/merge-fields

3 parameters

Param	Type	Required	Description
list_id	string	required	Mailchimp audience/list identifier.
count	integer	optional	Maximum number of items to return.
offset	integer	optional	Number of items to skip before collecting the response page.