Mailchimp

TypeDescription
addOrUpdateContactAdd or update an audience member
createEventCreate an event for an audience member

Add or update contact

Adds or updates a contact in a Mailchimp audience. Under the hood, this action calls the add or update a list member API endpoint. If the call fails, we'll retry it for you.

KeyTypeDefaultDescription
audienceString@mailchimp-audienceYour Mailchimp audience ID (a static value or a @secret reference)
apiKeyString@mailchimp-api-keyThe name of the StaticKit secret holding your API key (must be a @secret reference)
statusIfNewStringsubscribedThe contact's status if they are new (possible values: subscribed, unsubscribed, cleaned, pending, transaction)
dynamicFieldsObject{}A mapping of Mailchimp merge tags to form field names
staticFieldsObject{}Static values to set as merge tags
emailAddressFieldStringemailThe email address field name

Usage Example

{
"forms": {
"contact": {
"name": "Contact Form",
"actions": [
{
"app": "mailchimp",
"type": "addOrUpdateContact",
"audience": "8djs8fg8d",
"dynamicFields": {
"FNAME": "first_name"
},
"staticFields": {
"PLAN_NAME": "Pro"
}
}
]
}
}
}

Create event

Adds or updates a contact in a Mailchimp audience (to make sure they exist) and then creates an event for the contact, which you can use to trigger automations. Under the hood, this action calls the add or update a list member and create an event API endpoints. If either call fails, we'll retry them for you.

KeyTypeDefaultDescription
name *StringThe name of the event (e.g. joined_newsletter)
propertiesObject{}An optional object containing event properties
isSyncingBooleanfalseEvents created with the isSyncing value set to true will not trigger automations
audienceString@mailchimp-audienceYour Mailchimp audience ID (a static value or a @secret reference)
apiKeyString@mailchimp-api-keyThe name of the StaticKit secret holding your API key (must be a @secret reference)
statusIfNewStringsubscribedThe contact's status if they are new (possible values: subscribed, unsubscribed, cleaned, pending, transaction)
dynamicFieldsObject{}A mapping of Mailchimp merge tags to form field names
staticFieldsObject{}Static values to set as merge tags
emailAddressFieldStringemailThe email address field name

Usage Example

{
"forms": {
"order-form": {
"name": "Order Form",
"actions": [
{
"app": "mailchimp",
"type": "createEvent",
"audience": "8djs8fg8d",
"name": "purchased_book",
"properties": {
"skill_level": "expert"
}
}
]
}
}
}