Overview Add Mailchimp to any ModuleX agent or workflow. Mailchimp marketing platform integration via the v3.0 REST API. Pure HTTP. 19 actions across lists, subscribers, campaigns, tags, notes, and segments.
Categories : Marketing & Advertising · Marketing & Email · Email Marketing · CRM · Auth : OAuth2, API Key · Actions : 19
Authentication OAuth2 Authentication Connect using Mailchimp OAuth2 (recommended — avoids datacenter discovery and Basic Auth headaches). Required Credentials Field Description Required Format Client ID Mailchimp OAuth App Client ID Yes -Client Secret Mailchimp OAuth App Client Secret Yes -
OAuth Configuration
Authorization URL : https://login.mailchimp.com/oauth2/authorizeToken URL : https://login.mailchimp.com/oauth2/token API Key Authentication Authenticate using your Mailchimp API key. The key includes the datacenter suffix (e.g. xxx-us10). Required Credentials Field Description Required Format Mailchimp API Key Your Mailchimp API key (with datacenter suffix) Yes xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-us10Datacenter Datacenter portion of your API key (suffix after the dash, e.g. ‘us10’, ‘us20’, ‘eu1’). Mailchimp routes API requests to the datacenter where your account lives. Yes us10
Available Actions
get_lists — List all audiences
Parameters Results (max 1000) (Default: 10)
Results to skip (Default: 0)
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "lists" : { "items" : { "additionalProperties" : true , "type" : "object" }, "title" : "Lists" , "type" : "array" }, "total_items" : { "default" : 0 , "title" : "Total Items" , "type" : "integer" } }, "required" : [ "success" ], "title" : "GetListsOutput" , "type" : "object" }
get_list — Get details for a specific list/audience
Parameters The unique list/audience ID
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "id" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Id" }, "name" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Name" }, "permission_reminder" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Permission Reminder" }, "contact" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Contact" }, "campaign_defaults" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Campaign Defaults" }, "stats" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Stats" }, "date_created" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Date Created" } }, "required" : [ "success" ], "title" : "GetListOutput" , "type" : "object" }
create_list — Create a new audience
Parameters ISO3166 country code (e.g. ‘US’)
Default language (Default: en)
Allow subscribers to choose HTML or text (Default: false)
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "id" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Id" }, "name" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Name" }, "date_created" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Date Created" }, "message" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Message" } }, "required" : [ "success" ], "title" : "CreateListOutput" , "type" : "object" }
delete_list — Delete an audience (permanent)
Parameters The unique list/audience ID
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "message" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Message" }, "list_id" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "List Id" } }, "required" : [ "success" ], "title" : "DeleteListOutput" , "type" : "object" }
get_list_members — List members in an audience (optional status filter)
Parameters The unique list/audience ID
Results (max 1000) (Default: 10)
Results to skip (Default: 0)
subscribed/unsubscribed/cleaned/pending/transactional/archived
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "members" : { "items" : { "additionalProperties" : true , "type" : "object" }, "title" : "Members" , "type" : "array" }, "total_items" : { "default" : 0 , "title" : "Total Items" , "type" : "integer" } }, "required" : [ "success" ], "title" : "GetListMembersOutput" , "type" : "object" }
get_subscriber — Get a subscriber by email (MD5 hash lookup)
Parameters The unique list/audience ID
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "id" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Id" }, "email_address" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Email Address" }, "status" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Status" }, "merge_fields" : { "additionalProperties" : true , "title" : "Merge Fields" , "type" : "object" }, "tags" : { "items" : { "type" : "string" }, "title" : "Tags" , "type" : "array" }, "vip" : { "default" : false , "title" : "Vip" , "type" : "boolean" }, "language" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Language" }, "timestamp_signup" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Timestamp Signup" }, "last_changed" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Last Changed" } }, "required" : [ "success" ], "title" : "GetSubscriberOutput" , "type" : "object" }
add_or_update_subscriber — Upsert a subscriber via PUT (members/{md5_hash}); if tags are provided, POST them in a follow-up call
Parameters The unique list/audience ID
Status if new (default ‘subscribed’) (Default: subscribed)
Merge fields (e.g. {‘FNAME’: ‘John’})
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "id" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Id" }, "email_address" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Email Address" }, "status" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Status" }, "merge_fields" : { "additionalProperties" : true , "title" : "Merge Fields" , "type" : "object" }, "message" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Message" } }, "required" : [ "success" ], "title" : "AddOrUpdateSubscriberOutput" , "type" : "object" }
delete_subscriber — Permanently delete a subscriber via DELETE /members/{md5_hash}/actions/delete-permanent
Parameters The unique list/audience ID
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "message" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Message" }, "email" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Email" }, "list_id" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "List Id" } }, "required" : [ "success" ], "title" : "DeleteSubscriberOutput" , "type" : "object" }
get_campaigns — List campaigns (optional type/status filters)
Parameters Results (max 1000) (Default: 10)
Results to skip (Default: 0)
regular/plaintext/absplit/rss/variate
save/paused/schedule/sending/sent
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "campaigns" : { "items" : { "additionalProperties" : true , "type" : "object" }, "title" : "Campaigns" , "type" : "array" }, "total_items" : { "default" : 0 , "title" : "Total Items" , "type" : "integer" } }, "required" : [ "success" ], "title" : "GetCampaignsOutput" , "type" : "object" }
get_campaign — Get a specific campaign
Parameters Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "result" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Result" } }, "required" : [ "success" ], "title" : "GetCampaignOutput" , "type" : "object" }
create_campaign — Create a campaign (settings flattened from kwargs)
Parameters Campaign type (Default: regular)
The unique list/audience ID
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "id" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Id" }, "type" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Type" }, "status" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Status" }, "message" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Message" } }, "required" : [ "success" ], "title" : "CreateCampaignOutput" , "type" : "object" }
delete_campaign — Delete a campaign
Parameters Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "message" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Message" }, "campaign_id" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Campaign Id" } }, "required" : [ "success" ], "title" : "DeleteCampaignOutput" , "type" : "object" }
send_campaign — Send a campaign (POST /actions/send)
Parameters Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "message" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Message" }, "campaign_id" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Campaign Id" } }, "required" : [ "success" ], "title" : "SendCampaignOutput" , "type" : "object" }
get_campaign_report — Get a campaign's send/open/click report
Parameters Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "result" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Result" } }, "required" : [ "success" ], "title" : "GetCampaignReportOutput" , "type" : "object" }
get_member_tags — Get tags attached to a subscriber
update_member_tags — Update tags on a subscriber (active/inactive list)
add_note_to_subscriber — Add an internal note to a subscriber (max 1000 chars)
Parameters The unique list/audience ID
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "id" : { "anyOf" : [ { "type" : "integer" }, { "type" : "null" } ], "default" : null , "title" : "Id" }, "note" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Note" }, "email" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Email" }, "created_at" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Created At" } }, "required" : [ "success" ], "title" : "AddNoteToSubscriberOutput" , "type" : "object" }
get_segments — List segments in an audience
Parameters The unique list/audience ID
Results (max 1000) (Default: 10)
Results to skip (Default: 0)
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "segments" : { "items" : { "additionalProperties" : true , "type" : "object" }, "title" : "Segments" , "type" : "array" }, "total_items" : { "default" : 0 , "title" : "Total Items" , "type" : "integer" } }, "required" : [ "success" ], "title" : "GetSegmentsOutput" , "type" : "object" }
add_member_to_segment — Add a subscriber email to a static segment
Parameters The unique list/audience ID
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "message" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Message" }, "email" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Email" }, "segment_id" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Segment Id" } }, "required" : [ "success" ], "title" : "AddMemberToSegmentOutput" , "type" : "object" }
Links 
