Mailchimp

Node: mailchimp · Full type: n8n-nodes-base.mailchimp · Version: 1

Credentials

mailchimpApi (alias: @mailchimp) / mailchimpOAuth2Api (alias: @mailchimp)

CREDENTIAL @mailchimp = mailchimpApi "My Mailchimp"

Operations

Resource: campaign

delete

Parameter	Type	Default	Details
campaignId	string	""	required

get

Parameter	Type	Default	Details
campaignId	string	""	required

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	10
options	collection	{}	keys: beforeCreateTime, beforeSendTime, excludeFields, fields, listId, sinceCreateTime, ...

replicate

Parameter	Type	Default	Details
campaignId	string	""	required

resend

Parameter	Type	Default	Details
campaignId	string	""	required

send

Parameter	Type	Default	Details
campaignId	string	""	required

Resource: listGroup

getAll

Parameter	Type	Default	Details
list	options	""	required
groupCategory	options	""	required
returnAll	boolean	false
limit	number	500

Resource: member

create

Parameter	Type	Default	Details
list	options	""	required
email	string	""	required
status	options	""	required; cleaned, pending, subscribed, transactional, unsubscribed
jsonParameters	boolean	false
options	collection	{}	keys: emailType, language, ipOptIn, ipSignup, timestampSignup, tags, ...
locationFieldsUi	fixedCollection	{}	groups: locationFieldsValues
mergeFieldsUi	fixedCollection	{}	groups: mergeFieldsValues
mergeFieldsJson	json	""
locationJson	json	""
groupsUi	fixedCollection	{}	groups: groupsValues
groupJson	json	""

delete

Parameter	Type	Default	Details
list	options	""	required
email	string	""	required

get

Parameter	Type	Default	Details
list	options	""	required
email	string	""	required
options	collection	{}	keys: fields, excludeFields

getAll

Parameter	Type	Default	Details
list	options	""	required
returnAll	boolean	false
limit	number	500
options	collection	{}	keys: beforeLastChanged, beforeTimestampOpt, emailType, status, sinceLastChanged

update

Parameter	Type	Default	Details
list	options	""	required
email	string	""	required
jsonParameters	boolean	false
updateFields	collection	{}	keys: emailType, groupsUi, language, mergeFieldsUi, ipOptIn, ipSignup, ...
mergeFieldsJson	json	""
locationJson	json	""
groupJson	json	""

Resource: memberTag

create

Parameter	Type	Default	Details
list	options	""	required
email	string	""	required
tags	string	[]
options	collection	{}	keys: isSyncing

delete

Parameter	Type	Default	Details
list	options	""	required
email	string	""	required
tags	string	[]
options	collection	{}	keys: isSyncing

Common Parameters

Parameter	Type	Default	Details
authentication	options	"apiKey"	apiKey, oAuth2

Parameter Details

options children:

Parameter	Type	Default	Details
emailType	options	""	html, text
language	string	""
ipOptIn	string	""
ipSignup	string	""
timestampSignup	dateTime	""
tags	string	""
vip	boolean	false
timestampOpt	dateTime	""

locationFieldsUi children:

locationFieldsValues group:

Parameter	Type	Default	Details
latitude	string	""	required
longitude	string	""	required

mergeFieldsUi children:

mergeFieldsValues group:

Parameter	Type	Default	Details
name	options	""	required
value	string	""	required

groupsUi children:

groupsValues group:

Parameter	Type	Default	Details
categoryId	options	""
categoryFieldId	string	""
value	boolean	false

updateFields children:

Parameter	Type	Default	Details
emailType	options	""	html, text
groupsUi	fixedCollection	{}	groups: groupsValues
language	string	""
mergeFieldsUi	fixedCollection	{}	groups: mergeFieldsValues
ipOptIn	string	""
ipSignup	string	""
timestampSignup	dateTime	""
skipMergeValidation	boolean	false
status	options	""	cleaned, pending, subscribed, transactional, unsubscribed
vip	boolean	false
locationFieldsUi	fixedCollection	{}	groups: locationFieldsValues
timestampOpt	dateTime	""

Example

NODE "mailchimp" @mailchimp AS "Mailchimp" {
  resource: "campaign",
  operation: "get",
  email: {{ $json.email }},
  campaignId: {{ $json.campaignId }}
}