// Some code
[{
"handle": "lists",
"meta": {
"short": "Audiences",
"description": "Mailchimp audiences (lists) used to organize and target contacts for campaigns."
},
"endpoint": {
"value": "/lists",
"placeholders": []
},
"fields": [
{
"name": "id",
"type": "String",
"selector": ["id"],
"meta": {}
},
{
"name": "name",
"type": "String",
"selector": ["name"],
"meta": {}
},
{
"name": "contact_company",
"type": "String",
"selector": ["contact", "company"],
"meta": {}
},
{
"name": "contact_address1",
"type": "String",
"selector": ["contact", "address1"],
"meta": {}
},
{
"name": "contact_city",
"type": "String",
"selector": ["contact", "city"],
"meta": {}
},
{
"name": "permission_reminder",
"type": "String",
"selector": ["permission_reminder"],
"meta": {}
},
{
"name": "campaign_defaults_from_name",
"type": "String",
"selector": ["campaign_defaults", "from_name"],
"meta": {}
},
{
"name": "campaign_defaults_from_email",
"type": "String",
"selector": ["campaign_defaults", "from_email"],
"meta": {}
},
{
"name": "campaign_defaults_subject",
"type": "String",
"selector": ["campaign_defaults", "subject"],
"meta": {}
},
{
"name": "stats_member_count",
"type": "Integer",
"selector": ["stats", "member_count"],
"meta": {}
}
],
"operations": {
"list": {
"method": "GET",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {
"offset": {
"value": "{{offset}}",
"placeholders": [
{
"name": "offset",
"type": "Integer",
"description": "Number of records to skip",
"required": false,
"default": "0",
"options": []
}
]
},
"count": {
"value": "{{count}}",
"placeholders": [
{
"name": "count",
"type": "Integer",
"description": "Maximum number of records to return",
"required": false,
"default": "10",
"options": []
}
]
}
},
"bodyTemplate": {
"value": "",
"placeholders": []
}
},
"read": {
"method": "GET",
"path": {
"value": "/{{list_id}}",
"placeholders": [
{
"name": "list_id",
"type": "String",
"description": "The unique id for the list",
"required": true,
"default": "",
"options": []
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "",
"placeholders": []
}
},
"create": {
"method": "POST",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "{\"name\":\"{{name}}\",\"contact\":{{contact}},\"permission_reminder\":\"{{permission_reminder}}\",\"campaign_defaults\":{{campaign_defaults}},\"email_type_option\":{{email_type_option}}}",
"placeholders": [
{
"name": "name",
"type": "String",
"description": "Name of the audience",
"required": true,
"default": "",
"options": []
},
{
"name": "contact",
"type": "Object",
"description": "Contact information for the audience",
"required": true,
"default": "",
"options": []
},
{
"name": "permission_reminder",
"type": "String",
"description": "Permission reminder text",
"required": true,
"default": "",
"options": []
},
{
"name": "campaign_defaults",
"type": "Object",
"description": "Default values for campaigns",
"required": true,
"default": "",
"options": []
},
{
"name": "email_type_option",
"type": "Boolean",
"description": "Whether the audience supports multiple email types",
"required": true,
"default": "false",
"options": []
}
]
}
},
"update": {
"method": "PATCH",
"path": {
"value": "/{{list_id}}",
"placeholders": [
{
"name": "list_id",
"type": "String",
"description": "The unique id for the list",
"required": true,
"default": "",
"options": []
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "{\"name\":\"{{name}}\"}",
"placeholders": [
{
"name": "name",
"type": "String",
"description": "Updated audience name",
"required": false,
"default": "",
"options": []
}
]
}
},
"delete": {
"method": "DELETE",
"path": {
"value": "/{{list_id}}",
"placeholders": [
{
"name": "list_id",
"type": "String",
"description": "The unique id for the list",
"required": true,
"default": "",
"options": []
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "",
"placeholders": []
}
}
},
"webhooks": [
{
"event": "list_created",
"path": "/webhooks/mailchimp/lists/created",
"payload": [
{
"name": "id",
"type": "String",
"selector": ["data", "id"],
"meta": {}
},
{
"name": "name",
"type": "String",
"selector": ["data", "name"],
"meta": {}
}
]
},
{
"event": "list_updated",
"path": "/webhooks/mailchimp/lists/updated",
"payload": [
{
"name": "id",
"type": "String",
"selector": ["data", "id"],
"meta": {}
},
{
"name": "name",
"type": "String",
"selector": ["data", "name"],
"meta": {}
}
]
}
]
},
{
"handle": "members",
"meta": {
"short": "Contacts",
"description": "Contacts (subscribers, unsubscribed, and other audience members) belonging to a specific Mailchimp audience."
},
"endpoint": {
"value": "/lists/{{list_id}}/members",
"placeholders": [
{
"name": "list_id",
"type": "String",
"description": "The unique id for the audience (list) these members belong to.",
"required": true,
"default": "",
"options": []
}
]
},
"fields": [
{
"name": "id",
"type": "String",
"selector": ["id"],
"meta": {}
},
{
"name": "email_address",
"type": "String",
"selector": ["email_address"],
"meta": {}
},
{
"name": "status",
"type": "String",
"selector": ["status"],
"meta": {}
},
{
"name": "merge_fields_FNAME",
"type": "String",
"selector": ["merge_fields", "FNAME"],
"meta": {}
},
{
"name": "merge_fields_LNAME",
"type": "String",
"selector": ["merge_fields", "LNAME"],
"meta": {}
},
{
"name": "tags_0_name",
"type": "String",
"selector": ["tags", "0", "name"],
"meta": {}
},
{
"name": "timestamp_signup",
"type": "String",
"selector": ["timestamp_signup"],
"meta": {}
},
{
"name": "last_changed",
"type": "String",
"selector": ["last_changed"],
"meta": {}
}
],
"operations": {
"list": {
"method": "GET",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {
"status": {
"value": "{{status}}",
"placeholders": [
{
"name": "status",
"type": "String",
"description": "Filter members by status (subscribed, unsubscribed, cleaned, pending, transactional).",
"required": false,
"default": "",
"options": []
}
]
},
"offset": {
"value": "{{offset}}",
"placeholders": [
{
"name": "offset",
"type": "Integer",
"description": "Number of records to skip",
"required": false,
"default": "0",
"options": []
}
]
},
"count": {
"value": "{{count}}",
"placeholders": [
{
"name": "count",
"type": "Integer",
"description": "Maximum number of records to return",
"required": false,
"default": "10",
"options": []
}
]
}
},
"bodyTemplate": {
"value": "",
"placeholders": []
}
},
"read": {
"method": "GET",
"path": {
"value": "/{{subscriber_hash}}",
"placeholders": [
{
"name": "subscriber_hash",
"type": "String",
"description": "The MD5 hash of the lowercase version of the list member’s email address.",
"required": true,
"default": "",
"options": []
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "",
"placeholders": []
}
},
"create": {
"method": "POST",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "{\"email_address\":\"{{email_address}}\",\"status\":\"{{status}}\",\"merge_fields\":{{merge_fields}}}",
"placeholders": [
{
"name": "email_address",
"type": "String",
"description": "The subscriber's email address.",
"required": true,
"default": "",
"options": []
},
{
"name": "status",
"type": "String",
"description": "Subscriber status (subscribed, pending, unsubscribed, cleaned, transactional).",
"required": true,
"default": "subscribed",
"options": []
},
{
"name": "merge_fields",
"type": "Object",
"description": "Subscriber merge field data (e.g. FNAME, LNAME).",
"required": false,
"default": "{}",
"options": []
}
]
}
},
"update": {
"method": "PATCH",
"path": {
"value": "/{{subscriber_hash}}",
"placeholders": [
{
"name": "subscriber_hash",
"type": "String",
"description": "The MD5 hash of the lowercase version of the list member’s email address.",
"required": true,
"default": "",
"options": []
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "{\"status\":\"{{status}}\",\"merge_fields\":{{merge_fields}}}",
"placeholders": [
{
"name": "status",
"type": "String",
"description": "Updated subscriber status.",
"required": false,
"default": "",
"options": []
},
{
"name": "merge_fields",
"type": "Object",
"description": "Updated merge field data.",
"required": false,
"default": "{}",
"options": []
}
]
}
},
"delete": {
"method": "DELETE",
"path": {
"value": "/{{subscriber_hash}}",
"placeholders": [
{
"name": "subscriber_hash",
"type": "String",
"description": "The MD5 hash of the lowercase version of the list member’s email address.",
"required": true,
"default": "",
"options": []
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "",
"placeholders": []
}
}
},
"webhooks": [
{
"event": "member_subscribed",
"path": "/webhooks/mailchimp/members/subscribed",
"payload": [
{
"name": "list_id",
"type": "String",
"selector": ["data", "list_id"],
"meta": {}
},
{
"name": "email",
"type": "String",
"selector": ["data", "email"],
"meta": {}
},
{
"name": "status",
"type": "String",
"selector": ["data", "status"],
"meta": {}
}
]
},
{
"event": "member_unsubscribed",
"path": "/webhooks/mailchimp/members/unsubscribed",
"payload": [
{
"name": "list_id",
"type": "String",
"selector": ["data", "list_id"],
"meta": {}
},
{
"name": "email",
"type": "String",
"selector": ["data", "email"],
"meta": {}
},
{
"name": "reason",
"type": "String",
"selector": ["data", "reason"],
"meta": {}
}
]
},
{
"event": "member_profile_updated",
"path": "/webhooks/mailchimp/members/profile-updated",
"payload": [
{
"name": "list_id",
"type": "String",
"selector": ["data", "list_id"],
"meta": {}
},
{
"name": "email",
"type": "String",
"selector": ["data", "email"],
"meta": {}
}
]
}
]
},
{
"handle": "campaigns",
"meta": {
"short": "Campaigns",
"description": "Email campaigns created and sent from Mailchimp, including their content and delivery status."
},
"endpoint": {
"value": "/campaigns",
"placeholders": []
},
"fields": [
{
"name": "id",
"type": "String",
"selector": ["id"],
"meta": {}
},
{
"name": "type",
"type": "String",
"selector": ["type"],
"meta": {}
},
{
"name": "settings_subject_line",
"type": "String",
"selector": ["settings", "subject_line"],
"meta": {}
},
{
"name": "settings_title",
"type": "String",
"selector": ["settings", "title"],
"meta": {}
},
{
"name": "settings_from_name",
"type": "String",
"selector": ["settings", "from_name"],
"meta": {}
},
{
"name": "recipients_list_id",
"type": "String",
"selector": ["recipients", "list_id"],
"meta": {}
},
{
"name": "status",
"type": "String",
"selector": ["status"],
"meta": {}
},
{
"name": "send_time",
"type": "String",
"selector": ["send_time"],
"meta": {}
}
],
"operations": {
"list": {
"method": "GET",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {
"status": {
"value": "{{status}}",
"placeholders": [
{
"name": "status",
"type": "String",
"description": "Filter campaigns by status (save, paused, schedule, sending, sent).",
"required": false,
"default": "",
"options": []
}
]
},
"offset": {
"value": "{{offset}}",
"placeholders": [
{
"name": "offset",
"type": "Integer",
"description": "Number of records to skip",
"required": false,
"default": "0",
"options": []
}
]
},
"count": {
"value": "{{count}}",
"placeholders": [
{
"name": "count",
"type": "Integer",
"description": "Maximum number of records to return",
"required": false,
"default": "10",
"options": []
}
]
}
},
"bodyTemplate": {
"value": "",
"placeholders": []
}
},
"read": {
"method": "GET",
"path": {
"value": "/{{campaign_id}}",
"placeholders": [
{
"name": "campaign_id",
"type": "String",
"description": "The unique id for the campaign.",
"required": true,
"default": "",
"options": []
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "",
"placeholders": []
}
},
"create": {
"method": "POST",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "{\"type\":\"{{type}}\",\"recipients\":{\"list_id\":\"{{list_id}}\"},\"settings\":{\"subject_line\":\"{{subject_line}}\",\"title\":\"{{title}}\",\"from_name\":\"{{from_name}}\",\"reply_to\":\"{{reply_to}}\"}}",
"placeholders": [
{
"name": "type",
"type": "String",
"description": "Type of campaign (regular, plaintext, absplit, rss, variate).",
"required": true,
"default": "regular",
"options": []
},
{
"name": "list_id",
"type": "String",
"description": "Audience id to send the campaign to.",
"required": true,
"default": "",
"options": []
},
{
"name": "subject_line",
"type": "String",
"description": "Email subject line.",
"required": true,
"default": "",
"options": []
},
{
"name": "title",
"type": "String",
"description": "Internal campaign name.",
"required": true,
"default": "",
"options": []
},
{
"name": "from_name",
"type": "String",
"description": "Sender name.",
"required": true,
"default": "",
"options": []
},
{
"name": "reply_to",
"type": "String",
"description": "Reply-to email address.",
"required": true,
"default": "",
"options": []
}
]
}
},
"update": {
"method": "PATCH",
"path": {
"value": "/{{campaign_id}}",
"placeholders": [
{
"name": "campaign_id",
"type": "String",
"description": "The unique id for the campaign.",
"required": true,
"default": "",
"options": []
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "{\"settings\":{\"subject_line\":\"{{subject_line}}\",\"title\":\"{{title}}\"}}",
"placeholders": [
{
"name": "subject_line",
"type": "String",
"description": "Updated subject line.",
"required": false,
"default": "",
"options": []
},
{
"name": "title",
"type": "String",
"description": "Updated internal campaign name.",
"required": false,
"default": "",
"options": []
}
]
}
},
"delete": {
"method": "DELETE",
"path": {
"value": "/{{campaign_id}}",
"placeholders": [
{
"name": "campaign_id",
"type": "String",
"description": "The unique id for the campaign.",
"required": true,
"default": "",
"options": []
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "",
"placeholders": []
}
}
},
"webhooks": [
{
"event": "campaign_sent",
"path": "/webhooks/mailchimp/campaigns/sent",
"payload": [
{
"name": "campaign_id",
"type": "String",
"selector": ["data", "id"],
"meta": {}
},
{
"name": "status",
"type": "String",
"selector": ["data", "status"],
"meta": {}
},
{
"name": "send_time",
"type": "String",
"selector": ["data", "send_time"],
"meta": {}
}
]
}
]
},
{
"handle": "events",
"meta": {
"short": "Email Events",
"description": "Transactional and engagement events generated by Mailchimp when campaigns are sent and contacts interact with emails."
},
"endpoint": {
"value": "/events",
"placeholders": []
},
"fields": [
{
"name": "event",
"type": "String",
"selector": ["type"],
"meta": {}
},
{
"name": "campaign_id",
"type": "String",
"selector": ["data", "campaign_id"],
"meta": {}
},
{
"name": "list_id",
"type": "String",
"selector": ["data", "list_id"],
"meta": {}
},
{
"name": "email",
"type": "String",
"selector": ["data", "email"],
"meta": {}
},
{
"name": "timestamp",
"type": "String",
"selector": ["fired_at"],
"meta": {}
}
],
"operations": {},
"webhooks": [
{
"event": "email_sent",
"path": "/webhooks/mailchimp/events/sent",
"payload": [
{
"name": "campaign_id",
"type": "String",
"selector": ["data", "campaign_id"],
"meta": {}
},
{
"name": "email",
"type": "String",
"selector": ["data", "email"],
"meta": {}
},
{
"name": "timestamp",
"type": "String",
"selector": ["fired_at"],
"meta": {}
}
]
},
{
"event": "email_opened",
"path": "/webhooks/mailchimp/events/opened",
"payload": [
{
"name": "campaign_id",
"type": "String",
"selector": ["data", "campaign_id"],
"meta": {}
},
{
"name": "email",
"type": "String",
"selector": ["data", "email"],
"meta": {}
},
{
"name": "timestamp",
"type": "String",
"selector": ["fired_at"],
"meta": {}
}
]
},
{
"event": "email_clicked",
"path": "/webhooks/mailchimp/events/clicked",
"payload": [
{
"name": "campaign_id",
"type": "String",
"selector": ["data", "campaign_id"],
"meta": {}
},
{
"name": "email",
"type": "String",
"selector": ["data", "email"],
"meta": {}
},
{
"name": "url",
"type": "String",
"selector": ["data", "url"],
"meta": {}
},
{
"name": "timestamp",
"type": "String",
"selector": ["fired_at"],
"meta": {}
}
]
},
{
"event": "email_bounced",
"path": "/webhooks/mailchimp/events/bounced",
"payload": [
{
"name": "campaign_id",
"type": "String",
"selector": ["data", "campaign_id"],
"meta": {}
},
{
"name": "email",
"type": "String",
"selector": ["data", "email"],
"meta": {}
},
{
"name": "reason",
"type": "String",
"selector": ["data", "reason"],
"meta": {}
},
{
"name": "timestamp",
"type": "String",
"selector": ["fired_at"],
"meta": {}
}
]
},
{
"event": "email_spam",
"path": "/webhooks/mailchimp/events/spam",
"payload": [
{
"name": "campaign_id",
"type": "String",
"selector": ["data", "campaign_id"],
"meta": {}
},
{
"name": "email",
"type": "String",
"selector": ["data", "email"],
"meta": {}
},
{
"name": "timestamp",
"type": "String",
"selector": ["fired_at"],
"meta": {}
}
]
}
]
},
{
"handle": "segments",
"meta": {
"short": "Segments",
"description": "Manage segments for a specific Mailchimp audience."
},
"endpoint": {
"value": "/lists/{{list_id}}/segments",
"placeholders": [
{
"name": "list_id",
"type": "String",
"description": "The unique id for the list.",
"required": true,
"default": "",
"options": []
}
]
},
"fields": [
{
"name": "id",
"type": "Integer",
"selector": ["id"],
"meta": {}
},
{
"name": "name",
"type": "String",
"selector": ["name"],
"meta": {}
},
{
"name": "member_count",
"type": "Integer",
"selector": ["member_count"],
"meta": {}
},
{
"name": "created_at",
"type": "String",
"selector": ["created_at"],
"meta": {}
},
{
"name": "updated_at",
"type": "String",
"selector": ["updated_at"],
"meta": {}
}
],
"operations": {
"list": {
"method": "GET",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {
"count": {
"value": "10",
"placeholders": []
},
"offset": {
"value": "0",
"placeholders": []
}
},
"bodyTemplate": {
"value": "",
"placeholders": []
}
},
"read": {
"method": "GET",
"path": {
"value": "/{{segment_id}}",
"placeholders": [
{
"name": "segment_id",
"type": "String",
"description": "The unique id for the segment.",
"required": true,
"default": "",
"options": []
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "",
"placeholders": []
}
},
"create": {
"method": "POST",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "{\"name\":\"{{name}}\",\"static_segment\":{{static_segment}},\"options\":{{options}}}",
"placeholders": [
{
"name": "name",
"type": "String",
"description": "The name of the segment.",
"required": true,
"default": "",
"options": []
},
{
"name": "static_segment",
"type": "Array",
"description": "An array of emails to be used for a static segment.",
"required": false,
"default": "[]",
"options": []
},
{
"name": "options",
"type": "Object",
"description": "The conditions of the segment.",
"required": false,
"default": "{}",
"options": []
}
]
}
},
"update": {
"method": "PATCH",
"path": {
"value": "/{{segment_id}}",
"placeholders": [
{
"name": "segment_id",
"type": "String",
"description": "The unique id for the segment.",
"required": true,
"default": "",
"options": []
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "{\"name\":\"{{name}}\",\"static_segment\":{{static_segment}},\"options\":{{options}}}",
"placeholders": [
{
"name": "name",
"type": "String",
"description": "The name of the segment.",
"required": true,
"default": "",
"options": []
},
{
"name": "static_segment",
"type": "Array",
"description": "An array of emails to be used for a static segment.",
"required": false,
"default": "[]",
"options": []
},
{
"name": "options",
"type": "Object",
"description": "The conditions of the segment.",
"required": false,
"default": "{}",
"options": []
}
]
}
},
"delete": {
"method": "DELETE",
"path": {
"value": "/{{segment_id}}",
"placeholders": [
{
"name": "segment_id",
"type": "String",
"description": "The unique id for the segment.",
"required": true,
"default": "",
"options": []
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "",
"placeholders": []
}
}
},
"webhooks": []
},
{
"handle": "templates",
"meta": {
"short": "Templates",
"description": "Manage Mailchimp email templates."
},
"endpoint": {
"value": "/templates",
"placeholders": []
},
"fields": [
{
"name": "id",
"type": "Integer",
"selector": ["id"],
"meta": {}
},
{
"name": "type",
"type": "String",
"selector": ["type"],
"meta": {}
},
{
"name": "name",
"type": "String",
"selector": ["name"],
"meta": {}
},
{
"name": "drag_and_drop",
"type": "Boolean",
"selector": ["drag_and_drop"],
"meta": {}
},
{
"name": "date_created",
"type": "String",
"selector": ["date_created"],
"meta": {}
},
{
"name": "created_by",
"type": "String",
"selector": ["created_by"],
"meta": {}
}
],
"operations": {
"list": {
"method": "GET",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {
"type": {
"value": "{{type}}",
"placeholders": [
{
"name": "type",
"type": "String",
"description": "The template type (user, base, gallery).",
"required": false,
"default": "",
"options": []
}
]
},
"count": {
"value": "10",
"placeholders": []
},
"offset": {
"value": "0",
"placeholders": []
}
},
"bodyTemplate": {
"value": "",
"placeholders": []
}
},
"read": {
"method": "GET",
"path": {
"value": "/{{template_id}}",
"placeholders": [
{
"name": "template_id",
"type": "String",
"description": "The unique id for the template.",
"required": true,
"default": "",
"options": []
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "",
"placeholders": []
}
},
"create": {
"method": "POST",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "{\"name\":\"{{name}}\",\"html\":\"{{html}}\"}",
"placeholders": [
{
"name": "name",
"type": "String",
"description": "The name of the template.",
"required": true,
"default": "",
"options": []
},
{
"name": "html",
"type": "String",
"description": "The raw HTML for the template.",
"required": true,
"default": "",
"options": []
}
]
}
},
"update": {
"method": "PATCH",
"path": {
"value": "/{{template_id}}",
"placeholders": [
{
"name": "template_id",
"type": "String",
"description": "The unique id for the template.",
"required": true,
"default": "",
"options": []
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "{\"name\":\"{{name}}\",\"html\":\"{{html}}\"}",
"placeholders": [
{
"name": "name",
"type": "String",
"description": "The name of the template.",
"required": true,
"default": "",
"options": []
},
{
"name": "html",
"type": "String",
"description": "The raw HTML for the template.",
"required": true,
"default": "",
"options": []
}
]
}
},
"delete": {
"method": "DELETE",
"path": {
"value": "/{{template_id}}",
"placeholders": [
{
"name": "template_id",
"type": "String",
"description": "The unique id for the template.",
"required": true,
"default": "",
"options": []
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "",
"placeholders": []
}
}
},
"webhooks": []
},
{
"handle": "landing-pages",
"meta": {
"short": "Landing Pages",
"description": "Manage Landing Pages."
},
"endpoint": {
"value": "/landing-pages",
"placeholders": []
},
"fields": [
{
"name": "id",
"type": "String",
"selector": ["id"],
"meta": {}
},
{
"name": "name",
"type": "String",
"selector": ["name"],
"meta": {}
},
{
"name": "title",
"type": "String",
"selector": ["title"],
"meta": {}
},
{
"name": "description",
"type": "String",
"selector": ["description"],
"meta": {}
},
{
"name": "status",
"type": "String",
"selector": ["status"],
"meta": {}
},
{
"name": "list_id",
"type": "String",
"selector": ["list_id"],
"meta": {}
},
{
"name": "url",
"type": "String",
"selector": ["url"],
"meta": {}
}
],
"operations": {
"list": {
"method": "GET",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {
"count": {
"value": "10",
"placeholders": []
},
"offset": {
"value": "0",
"placeholders": []
}
},
"bodyTemplate": {
"value": "",
"placeholders": []
}
},
"read": {
"method": "GET",
"path": {
"value": "/{{page_id}}",
"placeholders": [
{
"name": "page_id",
"type": "String",
"description": "The unique id for the landing page.",
"required": true,
"default": "",
"options": []
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "",
"placeholders": []
}
},
"create": {
"method": "POST",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "{\"name\":\"{{name}}\",\"title\":\"{{title}}\",\"description\":\"{{description}}\",\"list_id\":\"{{list_id}}\",\"store_id\":\"{{store_id}}\"}",
"placeholders": [
{
"name": "name",
"type": "String",
"description": "The name of the landing page.",
"required": true,
"default": "",
"options": []
},
{
"name": "title",
"type": "String",
"description": "The title of the landing page seen in the browser's title bar.",
"required": false,
"default": "",
"options": []
},
{
"name": "description",
"type": "String",
"description": "The description of the landing page.",
"required": false,
"default": "",
"options": []
},
{
"name": "list_id",
"type": "String",
"description": "The list id to connect to the landing page.",
"required": false,
"default": "",
"options": []
},
{
"name": "store_id",
"type": "String",
"description": "The store id to connect to the landing page.",
"required": false,
"default": "",
"options": []
}
]
}
},
"update": {
"method": "PATCH",
"path": {
"value": "/{{page_id}}",
"placeholders": [
{
"name": "page_id",
"type": "String",
"description": "The unique id for the landing page.",
"required": true,
"default": "",
"options": []
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "{\"name\":\"{{name}}\",\"title\":\"{{title}}\",\"description\":\"{{description}}\",\"list_id\":\"{{list_id}}\",\"store_id\":\"{{store_id}}\"}",
"placeholders": [
{
"name": "name",
"type": "String",
"description": "The name of the landing page.",
"required": false,
"default": "",
"options": []
},
{
"name": "title",
"type": "String",
"description": "The title of the landing page seen in the browser's title bar.",
"required": false,
"default": "",
"options": []
},
{
"name": "description",
"type": "String",
"description": "The description of the landing page.",
"required": false,
"default": "",
"options": []
},
{
"name": "list_id",
"type": "String",
"description": "The list id to connect to the landing page.",
"required": false,
"default": "",
"options": []
},
{
"name": "store_id",
"type": "String",
"description": "The store id to connect to the landing page.",
"required": false,
"default": "",
"options": []
}
]
}
},
"delete": {
"method": "DELETE",
"path": {
"value": "/{{page_id}}",
"placeholders": [
{
"name": "page_id",
"type": "String",
"description": "The unique id for the landing page.",
"required": true,
"default": "",
"options": []
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "",
"placeholders": []
}
},
"publish": {
"method": "POST",
"path": {
"value": "/{{page_id}}/actions/publish",
"placeholders": [
{
"name": "page_id",
"type": "String",
"description": "The unique id for the landing page.",
"required": true,
"default": "",
"options": []
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "",
"placeholders": []
}
},
"unpublish": {
"method": "POST",
"path": {
"value": "/{{page_id}}/actions/unpublish",
"placeholders": [
{
"name": "page_id",
"type": "String",
"description": "The unique id for the landing page.",
"required": true,
"default": "",
"options": []
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "",
"placeholders": []
}
}
},
"webhooks": []
},
{
"handle": "reports",
"meta": {
"short": "Reports",
"description": "Campaign reports for Mailchimp."
},
"endpoint": {
"value": "/reports",
"placeholders": []
},
"fields": [
{
"name": "id",
"type": "String",
"selector": ["id"],
"meta": {}
},
{
"name": "campaign_title",
"type": "String",
"selector": ["campaign_title"],
"meta": {}
},
{
"name": "type",
"type": "String",
"selector": ["type"],
"meta": {}
},
{
"name": "emails_sent",
"type": "Integer",
"selector": ["emails_sent"],
"meta": {}
},
{
"name": "opens_total",
"type": "Integer",
"selector": ["opens", "opens_total"],
"meta": {}
},
{
"name": "clicks_total",
"type": "Integer",
"selector": ["clicks", "clicks_total"],
"meta": {}
}
],
"operations": {
"list": {
"method": "GET",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {
"count": {
"value": "10",
"placeholders": []
},
"offset": {
"value": "0",
"placeholders": []
}
},
"bodyTemplate": {
"value": "",
"placeholders": []
}
},
"read": {
"method": "GET",
"path": {
"value": "/{{campaign_id}}",
"placeholders": [
{
"name": "campaign_id",
"type": "String",
"description": "The unique id for the campaign.",
"required": true,
"default": "",
"options": []
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "",
"placeholders": []
}
}
},
"webhooks": []
},
{
"handle": "automations",
"meta": {
"short": "Automations",
"description": "Manage Classic Automations in Mailchimp."
},
"endpoint": {
"value": "/automations",
"placeholders": []
},
"fields": [
{
"name": "id",
"type": "String",
"selector": ["id"],
"meta": {}
},
{
"name": "status",
"type": "String",
"selector": ["status"],
"meta": {}
},
{
"name": "create_time",
"type": "String",
"selector": ["create_time"],
"meta": {}
},
{
"name": "start_time",
"type": "String",
"selector": ["start_time"],
"meta": {}
},
{
"name": "emails_sent",
"type": "Integer",
"selector": ["emails_sent"],
"meta": {}
}
],
"operations": {
"list": {
"method": "GET",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {
"status": {
"value": "{{status}}",
"placeholders": [
{
"name": "status",
"type": "String",
"description": "The status of the automation (save, paused, sending).",
"required": false,
"default": "",
"options": []
}
]
},
"count": {
"value": "10",
"placeholders": []
},
"offset": {
"value": "0",
"placeholders": []
}
},
"bodyTemplate": {
"value": "",
"placeholders": []
}
},
"read": {
"method": "GET",
"path": {
"value": "/{{workflow_id}}",
"placeholders": [
{
"name": "workflow_id",
"type": "String",
"description": "The unique id for the automation workflow.",
"required": true,
"default": "",
"options": []
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "",
"placeholders": []
}
}
},
"webhooks": []
},
{
"handle": "merge-fields",
"meta": {
"short": "Merge Fields",
"description": "Manage merge fields (audience fields) for a specific Mailchimp list."
},
"endpoint": {
"value": "/lists/{{list_id}}/merge-fields",
"placeholders": [
{
"name": "list_id",
"type": "String",
"description": "The unique id for the list.",
"required": true,
"default": "",
"options": []
}
]
},
"fields": [
{
"name": "merge_id",
"type": "Integer",
"selector": ["merge_id"],
"meta": {}
},
{
"name": "tag",
"type": "String",
"selector": ["tag"],
"meta": {}
},
{
"name": "name",
"type": "String",
"selector": ["name"],
"meta": {}
},
{
"name": "type",
"type": "String",
"selector": ["type"],
"meta": {}
},
{
"name": "required",
"type": "Boolean",
"selector": ["required"],
"meta": {}
},
{
"name": "default_value",
"type": "String",
"selector": ["default_value"],
"meta": {}
},
{
"name": "public",
"type": "Boolean",
"selector": ["public"],
"meta": {}
}
],
"operations": {
"list": {
"method": "GET",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {
"count": {
"value": "10",
"placeholders": []
},
"offset": {
"value": "0",
"placeholders": []
}
},
"bodyTemplate": {
"value": "",
"placeholders": []
}
},
"read": {
"method": "GET",
"path": {
"value": "/{{merge_id}}",
"placeholders": [
{
"name": "merge_id",
"type": "String",
"description": "The merge field id.",
"required": true,
"default": "",
"options": []
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "",
"placeholders": []
}
},
"create": {
"method": "POST",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "{\"name\":\"{{name}}\",\"type\":\"{{type}}\",\"tag\":\"{{tag}}\",\"required\":{{required}},\"default_value\":\"{{default_value}}\",\"public\":{{public}}}",
"placeholders": [
{
"name": "name",
"type": "String",
"description": "The name of the merge field.",
"required": true,
"default": "",
"options": []
},
{
"name": "type",
"type": "String",
"description": "The type for the merge field (text, number, address, phone, date, url, imageurl, zip, birthday, email).",
"required": true,
"default": "text",
"options": []
},
{
"name": "tag",
"type": "String",
"description": "The merge tag.",
"required": false,
"default": "",
"options": []
},
{
"name": "required",
"type": "Boolean",
"description": "Whether the merge field is required.",
"required": false,
"default": "false",
"options": []
},
{
"name": "default_value",
"type": "String",
"description": "The default value for the merge field if null.",
"required": false,
"default": "",
"options": []
},
{
"name": "public",
"type": "Boolean",
"description": "Whether the merge field is displayed on the signup form.",
"required": false,
"default": "false",
"options": []
}
]
}
},
"update": {
"method": "PATCH",
"path": {
"value": "/{{merge_id}}",
"placeholders": [
{
"name": "merge_id",
"type": "String",
"description": "The merge field id.",
"required": true,
"default": "",
"options": []
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "{\"name\":\"{{name}}\",\"required\":{{required}},\"default_value\":\"{{default_value}}\",\"public\":{{public}}}",
"placeholders": [
{
"name": "name",
"type": "String",
"description": "The name of the merge field.",
"required": false,
"default": "",
"options": []
},
{
"name": "required",
"type": "Boolean",
"description": "Whether the merge field is required.",
"required": false,
"default": "false",
"options": []
},
{
"name": "default_value",
"type": "String",
"description": "The default value for the merge field if null.",
"required": false,
"default": "",
"options": []
},
{
"name": "public",
"type": "Boolean",
"description": "Whether the merge field is displayed on the signup form.",
"required": false,
"default": "false",
"options": []
}
]
}
},
"delete": {
"method": "DELETE",
"path": {
"value": "/{{merge_id}}",
"placeholders": [
{
"name": "merge_id",
"type": "String",
"description": "The merge field id.",
"required": true,
"default": "",
"options": []
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "",
"placeholders": []
}
}
},
"webhooks": []
},
{
"handle": "tags",
"meta": {
"short": "Tags",
"description": "Manage member tags for a specific subscriber."
},
"endpoint": {
"value": "/lists/{{list_id}}/members/{{subscriber_hash}}/tags",
"placeholders": [
{
"name": "list_id",
"type": "String",
"description": "The unique id for the list.",
"required": true,
"default": "",
"options": []
},
{
"name": "subscriber_hash",
"type": "String",
"description": "The MD5 hash of the lowercase version of the list member's email address.",
"required": true,
"default": "",
"options": []
}
]
},
"fields": [
{
"name": "name",
"type": "String",
"selector": ["name"],
"meta": {}
},
{
"name": "status",
"type": "String",
"selector": ["status"],
"meta": {}
}
],
"operations": {
"create": {
"method": "POST",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "{\"tags\":[{\"name\":\"{{name}}\",\"status\":\"{{status}}\"}]}",
"placeholders": [
{
"name": "name",
"type": "String",
"description": "The name of the tag.",
"required": true,
"default": "",
"options": []
},
{
"name": "status",
"type": "String",
"description": "The status of the tag (active, inactive).",
"required": true,
"default": "active",
"options": ["active", "inactive"]
}
]
}
}
},
"webhooks": []
},
{
"handle": "ecommerce-stores",
"meta": {
"short": "E-commerce Stores",
"description": "Manage E-commerce Stores in Mailchimp."
},
"endpoint": {
"value": "/ecommerce/stores",
"placeholders": []
},
"fields": [
{
"name": "id",
"type": "String",
"selector": ["id"],
"meta": {}
},
{
"name": "list_id",
"type": "String",
"selector": ["list_id"],
"meta": {}
},
{
"name": "name",
"type": "String",
"selector": ["name"],
"meta": {}
},
{
"name": "platform",
"type": "String",
"selector": ["platform"],
"meta": {}
},
{
"name": "domain",
"type": "String",
"selector": ["domain"],
"meta": {}
},
{
"name": "is_syncing",
"type": "Boolean",
"selector": ["is_syncing"],
"meta": {}
},
{
"name": "email_address",
"type": "String",
"selector": ["email_address"],
"meta": {}
},
{
"name": "currency_code",
"type": "String",
"selector": ["currency_code"],
"meta": {}
}
],
"operations": {
"list": {
"method": "GET",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {
"count": {
"value": "10",
"placeholders": []
},
"offset": {
"value": "0",
"placeholders": []
}
},
"bodyTemplate": {
"value": "",
"placeholders": []
}
},
"read": {
"method": "GET",
"path": {
"value": "/{{store_id}}",
"placeholders": [
{
"name": "store_id",
"type": "String",
"description": "The store id.",
"required": true,
"default": "",
"options": []
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "",
"placeholders": []
}
},
"create": {
"method": "POST",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "{\"id\":\"{{id}}\",\"list_id\":\"{{list_id}}\",\"name\":\"{{name}}\",\"currency_code\":\"{{currency_code}}\",\"domain\":\"{{domain}}\"}",
"placeholders": [
{
"name": "id",
"type": "String",
"description": "The unique identifier for the store.",
"required": true,
"default": "",
"options": []
},
{
"name": "list_id",
"type": "String",
"description": "The list id for the store.",
"required": true,
"default": "",
"options": []
},
{
"name": "name",
"type": "String",
"description": "The name of the store.",
"required": true,
"default": "",
"options": []
},
{
"name": "currency_code",
"type": "String",
"description": "The three-letter ISO 4217 currency code.",
"required": true,
"default": "USD",
"options": []
},
{
"name": "domain",
"type": "String",
"description": "The store domain.",
"required": false,
"default": "",
"options": []
}
]
}
},
"update": {
"method": "PATCH",
"path": {
"value": "/{{store_id}}",
"placeholders": [
{
"name": "store_id",
"type": "String",
"description": "The store id.",
"required": true,
"default": "",
"options": []
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "{\"name\":\"{{name}}\",\"currency_code\":\"{{currency_code}}\",\"domain\":\"{{domain}}\"}",
"placeholders": [
{
"name": "name",
"type": "String",
"description": "The name of the store.",
"required": false,
"default": "",
"options": []
},
{
"name": "currency_code",
"type": "String",
"description": "The three-letter ISO 4217 currency code.",
"required": false,
"default": "",
"options": []
},
{
"name": "domain",
"type": "String",
"description": "The store domain.",
"required": false,
"default": "",
"options": []
}
]
}
},
"delete": {
"method": "DELETE",
"path": {
"value": "/{{store_id}}",
"placeholders": [
{
"name": "store_id",
"type": "String",
"description": "The store id.",
"required": true,
"default": "",
"options": []
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "",
"placeholders": []
}
}
},
"webhooks": []
}]