Business — entry 009 of 19

Mailchimp

Verified Jul 2026

Mailchimp's Marketing API (v3) gives REST access to audience/list management, campaign creation and scheduling, and marketing automation, served from a datacenter-specific host (e.g. us1.api.mailchimp.com) tied to each account's own API key. Every response is JSON, including RFC-7807-style problem+json error bodies confirmed live ("API Key Invalid" on an unauthenticated request), and the API is server-side only: a live probe returns no Access-Control-Allow-Origin header on either GET or OPTIONS.

email-marketingnewslettersmarketing-automationaudience-managementcampaigns

Visit mailchimp.com ↗Pricing ↗Status ↗More Business

AuthenticationAPI KeySign up with the provider to obtain credentials.

HTTPSSupportedTraffic is encrypted in transit.

CORSDisabledBrowser calls need a server-side proxy.

PricingFreemiumA usable free tier exists, with paid plans for more volume.

FormatsJSONResponses can be requested as JSON.

GreatAPIs Score

Score81out of 100

Authentication15/25API key required

Pricing17/20Freemium tier available

Docs20/20Machine-readable spec file bundled

Formats9/15Single response format

Freshness20/20Verified within 6 months

Embed this badge

<a href="https://greatapis.com/api/mailchimp/"><img src="https://greatapis.com/badge/mailchimp.svg" alt="Scored 81 on greatapis.com"></a>

Auth quickstart

Get a key at the provider
Send it on every request as a headerAuthorization: <key>
The exact header isn't documented — Authorization is a common default; confirm in the provider's docs.

Stored keyNo key stored

Your key is stored only in this browser (localStorage) and sent directly to the API — never to greatapis.

Endpoints

Servers

https://server.api.mailchimp.com/3.0

Auth

basicAuth

Surveys3

POST/lists/{list_id}/surveys/{survey_id}/actions/create-emailCreate a Survey Campaign

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`survey_id`	path	yes	string

Responses

Status	Description	Schema
`200`	Campaign Instance	—
`default`	An error generated by the Mailchimp API.	—

POST/lists/{list_id}/surveys/{survey_id}/actions/publishPublish a Survey

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`survey_id`	path	yes	string

Responses

Status	Description	Schema
`200`	Survey Published	—
`default`	An error generated by the Mailchimp API.	—

POST/lists/{list_id}/surveys/{survey_id}/actions/unpublishUnpublish a Survey

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`survey_id`	path	yes	string

Responses

Status	Description	Schema
`200`	Survey Instance	—
`default`	An error generated by the Mailchimp API.	—

accountExport1

GET/account-exports/{export_id}Get account export info

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`export_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

accountExports2

GET/account-exportsList account exports

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/account-exportsAdd export

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

activityFeed1

GET/activity-feed/chimp-chatterGet latest chimp chatter

Parameters

Name	In	Required	Type
`count`	query	no	integer
`offset`	query	no	integer

Responses

Status	Description	Schema
`200`	ChimpChatter Collection	—
`default`	An error generated by the Mailchimp API.	—

audiences4

GET/audiences/{audience_id}/contactsGet Contacts

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`cursor`	query	no	string
`created_before`	query	no	string
`created_since`	query	no	string
`updated_before`	query	no	string
`updated_since`	query	no	string
`audience_id`	path	yes	string
`sort_field`	query	no	string
`sort_dir`	query	no	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/audiences/{audience_id}/contactsAdd Contact

Parameters

Name	In	Required	Type
`audience_id`	path	yes	string
`merge_field_validation_mode`	query	no	string
`data_mode`	query	no	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/audiences/{audience_id}/contacts/{contact_id}Get Contact

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`audience_id`	path	yes	string
`contact_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PATCH/audiences/{audience_id}/contacts/{contact_id}Update Contact

Parameters

Name	In	Required	Type
`audience_id`	path	yes	string
`contact_id`	path	yes	string
`merge_field_validation_mode`	query	no	string
`data_mode`	query	no	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

authorizedApps2

GET/authorized-appsList authorized apps

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/authorized-apps/{app_id}Get authorized app info

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`app_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

automations18

GET/automationsList automations

Parameters

Name	In	Required	Type
`count`	query	no	integer
`offset`	query	no	integer
`fields`	query	no	array
`exclude_fields`	query	no	array
`before_create_time`	query	no	string
`since_create_time`	query	no	string
`before_start_time`	query	no	string
`since_start_time`	query	no	string
`status`	query	no	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/automationsAdd automation

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/automations/{workflow_id}Get automation info

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`workflow_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/automations/{workflow_id}/actions/archiveArchive automation

Parameters

Name	In	Required	Type
`workflow_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

POST/automations/{workflow_id}/actions/pause-all-emailsPause automation emails

Parameters

Name	In	Required	Type
`workflow_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

POST/automations/{workflow_id}/actions/start-all-emailsStart automation emails

Parameters

Name	In	Required	Type
`workflow_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

GET/automations/{workflow_id}/emailsList automated emails

Parameters

Name	In	Required	Type
`workflow_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/automations/{workflow_id}/emails/{workflow_email_id}Get workflow email info

Parameters

Name	In	Required	Type
`workflow_id`	path	yes	string
`workflow_email_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PATCH/automations/{workflow_id}/emails/{workflow_email_id}Update workflow email

Parameters

Name	In	Required	Type
`workflow_id`	path	yes	string
`workflow_email_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/automations/{workflow_id}/emails/{workflow_email_id}Delete workflow email

Parameters

Name	In	Required	Type
`workflow_id`	path	yes	string
`workflow_email_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

POST/automations/{workflow_id}/emails/{workflow_email_id}/actions/pausePause automated email

Parameters

Name	In	Required	Type
`workflow_id`	path	yes	string
`workflow_email_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

POST/automations/{workflow_id}/emails/{workflow_email_id}/actions/startStart automated email

Parameters

Name	In	Required	Type
`workflow_id`	path	yes	string
`workflow_email_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

GET/automations/{workflow_id}/emails/{workflow_email_id}/queueList automated email subscribers

Parameters

Name	In	Required	Type
`workflow_id`	path	yes	string
`workflow_email_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/automations/{workflow_id}/emails/{workflow_email_id}/queueAdd subscriber to workflow email

Parameters

Name	In	Required	Type
`workflow_id`	path	yes	string
`workflow_email_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/automations/{workflow_id}/emails/{workflow_email_id}/queue/{subscriber_hash}Get automated email subscriber

Parameters

Name	In	Required	Type
`workflow_id`	path	yes	string
`workflow_email_id`	path	yes	string
`subscriber_hash`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/automations/{workflow_id}/removed-subscribersList subscribers removed from workflow

Parameters

Name	In	Required	Type
`workflow_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/automations/{workflow_id}/removed-subscribersRemove subscriber from workflow

Parameters

Name	In	Required	Type
`workflow_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/automations/{workflow_id}/removed-subscribers/{subscriber_hash}Get subscriber removed from workflow

Parameters

Name	In	Required	Type
`workflow_id`	path	yes	string
`subscriber_hash`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

batchWebhooks5

GET/batch-webhooksList batch webhooks

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/batch-webhooksAdd batch webhook

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/batch-webhooks/{batch_webhook_id}Get batch webhook info

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`batch_webhook_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PATCH/batch-webhooks/{batch_webhook_id}Update batch webhook

Parameters

Name	In	Required	Type
`batch_webhook_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/batch-webhooks/{batch_webhook_id}Delete batch webhook

Parameters

Name	In	Required	Type
`batch_webhook_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

batches4

GET/batchesList batch requests

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/batchesStart batch operation

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/batches/{batch_id}Get batch operation status

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`batch_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/batches/{batch_id}Delete batch request

Parameters

Name	In	Required	Type
`batch_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

campaignFolders5

GET/campaign-foldersList campaign folders

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/campaign-foldersAdd campaign folder

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/campaign-folders/{folder_id}Get campaign folder

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`folder_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PATCH/campaign-folders/{folder_id}Update campaign folder

Parameters

Name	In	Required	Type
`folder_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/campaign-folders/{folder_id}Delete campaign folder

Parameters

Name	In	Required	Type
`folder_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

campaigns22

GET/campaignsList campaigns

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`type`	query	no	string
`status`	query	no	string
`before_send_time`	query	no	string
`since_send_time`	query	no	string
`before_create_time`	query	no	string
`since_create_time`	query	no	string
`list_id`	query	no	string
`folder_id`	query	no	string
`member_id`	query	no	string
`sort_field`	query	no	string
`sort_dir`	query	no	string
`include_resend_shortcut_eligibility`	query	no	boolean
`include_resend_shortcut_usage`	query	no	boolean

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/campaignsAdd campaign

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/campaigns/{campaign_id}Get campaign info

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`campaign_id`	path	yes	string
`include_resend_shortcut_eligibility`	query	no	boolean
`include_resend_shortcut_usage`	query	no	boolean

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PATCH/campaigns/{campaign_id}Update campaign settings

Parameters

Name	In	Required	Type
`campaign_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/campaigns/{campaign_id}Delete campaign

Parameters

Name	In	Required	Type
`campaign_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

POST/campaigns/{campaign_id}/actions/cancel-sendCancel campaign

Parameters

Name	In	Required	Type
`campaign_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

POST/campaigns/{campaign_id}/actions/create-resendResend campaign

Parameters

Name	In	Required	Type
`campaign_id`	path	yes	string

Request body

application/json

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/campaigns/{campaign_id}/actions/pausePause rss campaign

Parameters

Name	In	Required	Type
`campaign_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

POST/campaigns/{campaign_id}/actions/replicateReplicate campaign

Parameters

Name	In	Required	Type
`campaign_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/campaigns/{campaign_id}/actions/resumeResume rss campaign

Parameters

Name	In	Required	Type
`campaign_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

POST/campaigns/{campaign_id}/actions/scheduleSchedule campaign

Parameters

Name	In	Required	Type
`campaign_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

POST/campaigns/{campaign_id}/actions/sendSend campaign

Parameters

Name	In	Required	Type
`campaign_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

POST/campaigns/{campaign_id}/actions/testSend test email

Parameters

Name	In	Required	Type
`campaign_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

POST/campaigns/{campaign_id}/actions/unscheduleUnschedule campaign

Parameters

Name	In	Required	Type
`campaign_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

GET/campaigns/{campaign_id}/contentGet campaign content

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`campaign_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PUT/campaigns/{campaign_id}/contentSet campaign content

Parameters

Name	In	Required	Type
`campaign_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/campaigns/{campaign_id}/feedbackList campaign feedback

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`campaign_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/campaigns/{campaign_id}/feedbackAdd campaign feedback

Parameters

Name	In	Required	Type
`campaign_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/campaigns/{campaign_id}/feedback/{feedback_id}Get campaign feedback message

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`campaign_id`	path	yes	string
`feedback_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PATCH/campaigns/{campaign_id}/feedback/{feedback_id}Update campaign feedback message

Parameters

Name	In	Required	Type
`campaign_id`	path	yes	string
`feedback_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/campaigns/{campaign_id}/feedback/{feedback_id}Delete campaign feedback message

Parameters

Name	In	Required	Type
`campaign_id`	path	yes	string
`feedback_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

GET/campaigns/{campaign_id}/send-checklistGet campaign send checklist

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`campaign_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

connectedSites7

GET/connected-sitesList connected sites

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/connected-sitesAdd connected site

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/connected-sites/{connected_site_id}Get connected site

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`connected_site_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/connected-sites/{connected_site_id}Delete connected site

Parameters

Name	In	Required	Type
`connected_site_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

POST/connected-sites/{connected_site_id}/actions/disable-pixelDisable pixel for connected site

Parameters

Name	In	Required	Type
`connected_site_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

POST/connected-sites/{connected_site_id}/actions/enable-pixelEnable pixel for connected site

Parameters

Name	In	Required	Type
`connected_site_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

POST/connected-sites/{connected_site_id}/actions/verify-script-installationVerify connected site script

Parameters

Name	In	Required	Type
`connected_site_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

contacts4

GET/audiencesGet a list of audiences

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/audiences/{audience_id}Get audience info

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`audience_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/audiences/{audience_id}/contacts/{contact_id}/actions/archiveArchive Contact

Parameters

Name	In	Required	Type
`audience_id`	path	yes	string
`contact_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

POST/audiences/{audience_id}/contacts/{contact_id}/actions/forgetForget Contact

Parameters

Name	In	Required	Type
`audience_id`	path	yes	string
`contact_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

conversations4

GET/conversationsList conversations

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`has_unread_messages`	query	no	string
`list_id`	query	no	string
`campaign_id`	query	no	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/conversations/{conversation_id}Get conversation

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`conversation_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/conversations/{conversation_id}/messagesList messages

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`conversation_id`	path	yes	string
`is_read`	query	no	string
`before_timestamp`	query	no	string
`since_timestamp`	query	no	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/conversations/{conversation_id}/messages/{message_id}Get message

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`conversation_id`	path	yes	string
`message_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

customerJourneys1

POST/customer-journeys/journeys/{journey_id}/steps/{step_id}/actions/triggerCustomer Journeys API trigger for a contact

Parameters

Name	In	Required	Type
`journey_id`	path	yes	integer
`step_id`	path	yes	integer

Request body

application/json (required)

Responses

Status	Description	Schema
`204`	An empty response	—
`default`	An error generated by the Mailchimp API.	—

ecommerce60

GET/ecommerce/ordersList account orders

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`campaign_id`	query	no	string
`outreach_id`	query	no	string
`customer_id`	query	no	string
`has_outreach`	query	no	boolean

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/ecommerce/storesList stores

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/ecommerce/storesAdd store

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/ecommerce/stores/{store_id}Get store info

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`store_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PATCH/ecommerce/stores/{store_id}Update store

Parameters

Name	In	Required	Type
`store_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/ecommerce/stores/{store_id}Delete store

Parameters

Name	In	Required	Type
`store_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

GET/ecommerce/stores/{store_id}/cartsList carts

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`store_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/ecommerce/stores/{store_id}/cartsAdd cart

Parameters

Name	In	Required	Type
`store_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/ecommerce/stores/{store_id}/carts/{cart_id}Get cart info

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`store_id`	path	yes	string
`cart_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PATCH/ecommerce/stores/{store_id}/carts/{cart_id}Update cart

Parameters

Name	In	Required	Type
`store_id`	path	yes	string
`cart_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/ecommerce/stores/{store_id}/carts/{cart_id}Delete cart

Parameters

Name	In	Required	Type
`store_id`	path	yes	string
`cart_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

GET/ecommerce/stores/{store_id}/carts/{cart_id}/linesList cart line items

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`store_id`	path	yes	string
`cart_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/ecommerce/stores/{store_id}/carts/{cart_id}/linesAdd cart line item

Parameters

Name	In	Required	Type
`store_id`	path	yes	string
`cart_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}Get cart line item

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`store_id`	path	yes	string
`cart_id`	path	yes	string
`line_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PATCH/ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}Update cart line item

Parameters

Name	In	Required	Type
`store_id`	path	yes	string
`cart_id`	path	yes	string
`line_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}Delete cart line item

Parameters

Name	In	Required	Type
`store_id`	path	yes	string
`cart_id`	path	yes	string
`line_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

GET/ecommerce/stores/{store_id}/customersList customers

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`store_id`	path	yes	string
`email_address`	query	no	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/ecommerce/stores/{store_id}/customersAdd customer

Parameters

Name	In	Required	Type
`store_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/ecommerce/stores/{store_id}/customers/{customer_id}Get customer info

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`store_id`	path	yes	string
`customer_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PUT/ecommerce/stores/{store_id}/customers/{customer_id}Add or update customer

Parameters

Name	In	Required	Type
`store_id`	path	yes	string
`customer_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PATCH/ecommerce/stores/{store_id}/customers/{customer_id}Update customer

Parameters

Name	In	Required	Type
`store_id`	path	yes	string
`customer_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/ecommerce/stores/{store_id}/customers/{customer_id}Delete customer

Parameters

Name	In	Required	Type
`store_id`	path	yes	string
`customer_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

GET/ecommerce/stores/{store_id}/ordersList orders

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`store_id`	path	yes	string
`customer_id`	query	no	string
`has_outreach`	query	no	boolean
`campaign_id`	query	no	string
`outreach_id`	query	no	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/ecommerce/stores/{store_id}/ordersAdd order

Parameters

Name	In	Required	Type
`store_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/ecommerce/stores/{store_id}/orders/{order_id}Get order info

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`store_id`	path	yes	string
`order_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PUT/ecommerce/stores/{store_id}/orders/{order_id}Add or update order

Parameters

Name	In	Required	Type
`store_id`	path	yes	string
`order_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PATCH/ecommerce/stores/{store_id}/orders/{order_id}Update order

Parameters

Name	In	Required	Type
`store_id`	path	yes	string
`order_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/ecommerce/stores/{store_id}/orders/{order_id}Delete order

Parameters

Name	In	Required	Type
`store_id`	path	yes	string
`order_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

GET/ecommerce/stores/{store_id}/orders/{order_id}/linesList order line items

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`store_id`	path	yes	string
`order_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/ecommerce/stores/{store_id}/orders/{order_id}/linesAdd order line item

Parameters

Name	In	Required	Type
`store_id`	path	yes	string
`order_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}Get order line item

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`store_id`	path	yes	string
`order_id`	path	yes	string
`line_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PATCH/ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}Update order line item

Parameters

Name	In	Required	Type
`store_id`	path	yes	string
`order_id`	path	yes	string
`line_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}Delete order line item

Parameters

Name	In	Required	Type
`store_id`	path	yes	string
`order_id`	path	yes	string
`line_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

GET/ecommerce/stores/{store_id}/productsList product

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`store_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/ecommerce/stores/{store_id}/productsAdd product

Parameters

Name	In	Required	Type
`store_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/ecommerce/stores/{store_id}/products/{product_id}Get product info

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`store_id`	path	yes	string
`product_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PUT/ecommerce/stores/{store_id}/products/{product_id}Create or update product

Parameters

Name	In	Required	Type
`store_id`	path	yes	string
`product_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PATCH/ecommerce/stores/{store_id}/products/{product_id}Update product

Parameters

Name	In	Required	Type
`store_id`	path	yes	string
`product_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/ecommerce/stores/{store_id}/products/{product_id}Delete product

Parameters

Name	In	Required	Type
`store_id`	path	yes	string
`product_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

GET/ecommerce/stores/{store_id}/products/{product_id}/imagesList product images

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`store_id`	path	yes	string
`product_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/ecommerce/stores/{store_id}/products/{product_id}/imagesAdd product image

Parameters

Name	In	Required	Type
`store_id`	path	yes	string
`product_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}Get product image info

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`store_id`	path	yes	string
`product_id`	path	yes	string
`image_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PATCH/ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}Update product image

Parameters

Name	In	Required	Type
`store_id`	path	yes	string
`product_id`	path	yes	string
`image_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}Delete product image

Parameters

Name	In	Required	Type
`store_id`	path	yes	string
`product_id`	path	yes	string
`image_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

GET/ecommerce/stores/{store_id}/products/{product_id}/variantsList product variants

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`store_id`	path	yes	string
`product_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/ecommerce/stores/{store_id}/products/{product_id}/variantsAdd product variant

Parameters

Name	In	Required	Type
`store_id`	path	yes	string
`product_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}Get product variant info

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`store_id`	path	yes	string
`product_id`	path	yes	string
`variant_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PUT/ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}Add or update product variant

Parameters

Name	In	Required	Type
`store_id`	path	yes	string
`product_id`	path	yes	string
`variant_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PATCH/ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}Update product variant

Parameters

Name	In	Required	Type
`store_id`	path	yes	string
`product_id`	path	yes	string
`variant_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}Delete product variant

Parameters

Name	In	Required	Type
`store_id`	path	yes	string
`product_id`	path	yes	string
`variant_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

GET/ecommerce/stores/{store_id}/promo-rulesList promo rules

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`store_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/ecommerce/stores/{store_id}/promo-rulesAdd promo rule

Parameters

Name	In	Required	Type
`store_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}Get promo rule

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`store_id`	path	yes	string
`promo_rule_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PATCH/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}Update promo rule

Parameters

Name	In	Required	Type
`store_id`	path	yes	string
`promo_rule_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}Delete promo rule

Parameters

Name	In	Required	Type
`store_id`	path	yes	string
`promo_rule_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

GET/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codesList promo codes

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`promo_rule_id`	path	yes	string
`store_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codesAdd promo code

Parameters

Name	In	Required	Type
`store_id`	path	yes	string
`promo_rule_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}Get promo code

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`store_id`	path	yes	string
`promo_rule_id`	path	yes	string
`promo_code_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PATCH/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}Update promo code

Parameters

Name	In	Required	Type
`store_id`	path	yes	string
`promo_rule_id`	path	yes	string
`promo_code_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}Delete promo code

Parameters

Name	In	Required	Type
`store_id`	path	yes	string
`promo_rule_id`	path	yes	string
`promo_code_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

facebookAds2

GET/facebook-adsList facebook ads

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`sort_field`	query	no	string
`sort_dir`	query	no	string

Responses

Status	Description	Schema
`200`	List of Facebook Ad Instances	—
`default`	An error generated by the Mailchimp API.	—

GET/facebook-ads/{outreach_id}Get facebook ad info

Parameters

Name	In	Required	Type
`fields`	query	no	array
`outreach_id`	path	yes	string
`exclude_fields`	query	no	array

Responses

Status	Description	Schema
`200`	Facebook Ad Instance	—
`default`	An error generated by the Mailchimp API.	—

fileManager11

GET/file-manager/filesList stored files

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`type`	query	no	string
`created_by`	query	no	string
`before_created_at`	query	no	string
`since_created_at`	query	no	string
`sort_field`	query	no	string
`sort_dir`	query	no	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/file-manager/filesAdd file

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/file-manager/files/{file_id}Get file

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`file_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PATCH/file-manager/files/{file_id}Update file

Parameters

Name	In	Required	Type
`file_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/file-manager/files/{file_id}Delete file

Parameters

Name	In	Required	Type
`file_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

GET/file-manager/foldersList folders

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`created_by`	query	no	string
`before_created_at`	query	no	string
`since_created_at`	query	no	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/file-manager/foldersAdd folder

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/file-manager/folders/{folder_id}Get folder

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`folder_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PATCH/file-manager/folders/{folder_id}Update folder

Parameters

Name	In	Required	Type
`folder_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/file-manager/folders/{folder_id}Delete folder

Parameters

Name	In	Required	Type
`folder_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

GET/file-manager/folders/{folder_id}/filesList stored files

Parameters

Name	In	Required	Type
`folder_id`	path	yes	string
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`type`	query	no	string
`created_by`	query	no	string
`before_created_at`	query	no	string
`since_created_at`	query	no	string
`sort_field`	query	no	string
`sort_dir`	query	no	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

landingPages8

GET/landing-pagesList landing pages

Parameters

Name	In	Required	Type
`sort_dir`	query	no	string
`sort_field`	query	no	string
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer

Responses

Status	Description	Schema
`200`	Landing Pages Collection	—
`default`	An error generated by the Mailchimp API.	—

POST/landing-pagesAdd landing page

Parameters

Name	In	Required	Type
`use_default_list`	query	no	boolean

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/landing-pages/{page_id}Get landing page info

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`page_id`	path	yes	string

Responses

Status	Description	Schema
`200`	Landing Pages Instance	—
`default`	An error generated by the Mailchimp API.	—

PATCH/landing-pages/{page_id}Update landing page

Parameters

Name	In	Required	Type
`page_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/landing-pages/{page_id}Delete landing page

Parameters

Name	In	Required	Type
`page_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

POST/landing-pages/{page_id}/actions/publishPublish landing page

Parameters

Name	In	Required	Type
`page_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

POST/landing-pages/{page_id}/actions/unpublishUnpublish landing page

Parameters

Name	In	Required	Type
`page_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

GET/landing-pages/{page_id}/contentGet landing page content

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`page_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

lists70

GET/listsGet lists info

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`before_date_created`	query	no	string
`since_date_created`	query	no	string
`before_campaign_last_sent`	query	no	string
`since_campaign_last_sent`	query	no	string
`email`	query	no	string
`sort_field`	query	no	string
`sort_dir`	query	no	string
`has_ecommerce_store`	query	no	boolean
`include_total_contacts`	query	no	boolean

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/listsAdd list

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/lists/{list_id}Get list info

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`list_id`	path	yes	string
`include_total_contacts`	query	no	boolean

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/lists/{list_id}Batch subscribe or unsubscribe

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`skip_merge_validation`	query	no	boolean
`skip_duplicate_check`	query	no	boolean

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PATCH/lists/{list_id}Update lists

Parameters

Name	In	Required	Type
`list_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/lists/{list_id}Delete list

Parameters

Name	In	Required	Type
`list_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

GET/lists/{list_id}/abuse-reportsList abuse reports

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`list_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/lists/{list_id}/abuse-reports/{report_id}Get abuse report

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`list_id`	path	yes	string
`report_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/lists/{list_id}/activityList recent activity

Parameters

Name	In	Required	Type
`count`	query	no	integer
`offset`	query	no	integer
`fields`	query	no	array
`exclude_fields`	query	no	array
`list_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/lists/{list_id}/clientsList top email clients

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`list_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/lists/{list_id}/growth-historyList growth history data

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`list_id`	path	yes	string
`sort_field`	query	no	string
`sort_dir`	query	no	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/lists/{list_id}/growth-history/{month}Get growth history by month

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`list_id`	path	yes	string
`month`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/lists/{list_id}/interest-categoriesList interest categories

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`type`	query	no	string
`sort_field`	query	no	string
`sort_dir`	query	no	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/lists/{list_id}/interest-categoriesAdd interest category

Parameters

Name	In	Required	Type
`list_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/lists/{list_id}/interest-categories/{interest_category_id}Get interest category info

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`interest_category_id`	path	yes	string
`fields`	query	no	array
`exclude_fields`	query	no	array

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PATCH/lists/{list_id}/interest-categories/{interest_category_id}Update interest category

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`interest_category_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/lists/{list_id}/interest-categories/{interest_category_id}Delete interest category

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`interest_category_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

GET/lists/{list_id}/interest-categories/{interest_category_id}/interestsList interests in category

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`interest_category_id`	path	yes	string
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/lists/{list_id}/interest-categories/{interest_category_id}/interestsAdd interest in category

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`interest_category_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}Get interest in category

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`interest_category_id`	path	yes	string
`interest_id`	path	yes	string
`fields`	query	no	array
`exclude_fields`	query	no	array

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PATCH/lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}Update interest in category

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`interest_category_id`	path	yes	string
`interest_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}Delete interest in category

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`interest_category_id`	path	yes	string
`interest_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

GET/lists/{list_id}/locationsList locations

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`list_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/lists/{list_id}/membersList members info

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`list_id`	path	yes	string
`email_type`	query	no	string
`status`	query	no	string
`since_timestamp_opt`	query	no	string
`before_timestamp_opt`	query	no	string
`since_last_changed`	query	no	string
`before_last_changed`	query	no	string
`unique_email_id`	query	no	string
`vip_only`	query	no	boolean
`interest_category_id`	query	no	string
`interest_ids`	query	no	string
`interest_match`	query	no	string
`sort_field`	query	no	string
`sort_dir`	query	no	string
`since_last_campaign`	query	no	boolean
`unsubscribed_since`	query	no	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/lists/{list_id}/membersAdd member to list

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`skip_merge_validation`	query	no	boolean

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/lists/{list_id}/members/{subscriber_hash}Get member info

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`list_id`	path	yes	string
`subscriber_hash`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PUT/lists/{list_id}/members/{subscriber_hash}Add or update list member

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`subscriber_hash`	path	yes	string
`skip_merge_validation`	query	no	boolean

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PATCH/lists/{list_id}/members/{subscriber_hash}Update list member

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`subscriber_hash`	path	yes	string
`skip_merge_validation`	query	no	boolean

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/lists/{list_id}/members/{subscriber_hash}Archive list member

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`subscriber_hash`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

POST/lists/{list_id}/members/{subscriber_hash}/actions/delete-permanentDelete list member

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`subscriber_hash`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

GET/lists/{list_id}/members/{subscriber_hash}/activityView recent activity 50

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`subscriber_hash`	path	yes	string
`fields`	query	no	array
`exclude_fields`	query	no	array
`action`	query	no	array

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/lists/{list_id}/members/{subscriber_hash}/activity-feedView recent activity

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`subscriber_hash`	path	yes	string
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`activity_filters`	query	no	array

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/lists/{list_id}/members/{subscriber_hash}/eventsList member events

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`subscriber_hash`	path	yes	string
`count`	query	no	integer
`offset`	query	no	integer
`fields`	query	no	array
`exclude_fields`	query	no	array

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/lists/{list_id}/members/{subscriber_hash}/eventsAdd event

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`subscriber_hash`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

GET/lists/{list_id}/members/{subscriber_hash}/goalsList member goal events

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`subscriber_hash`	path	yes	string
`fields`	query	no	array
`exclude_fields`	query	no	array

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/lists/{list_id}/members/{subscriber_hash}/notesList recent member notes

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`subscriber_hash`	path	yes	string
`sort_field`	query	no	string
`sort_dir`	query	no	string
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/lists/{list_id}/members/{subscriber_hash}/notesAdd member note

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`subscriber_hash`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/lists/{list_id}/members/{subscriber_hash}/notes/{note_id}Get member note

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`subscriber_hash`	path	yes	string
`note_id`	path	yes	string
`fields`	query	no	array
`exclude_fields`	query	no	array

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PATCH/lists/{list_id}/members/{subscriber_hash}/notes/{note_id}Update note

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`subscriber_hash`	path	yes	string
`note_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/lists/{list_id}/members/{subscriber_hash}/notes/{note_id}Delete note

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`subscriber_hash`	path	yes	string
`note_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

GET/lists/{list_id}/members/{subscriber_hash}/tagsList member tags

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`subscriber_hash`	path	yes	string
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/lists/{list_id}/members/{subscriber_hash}/tagsAdd or remove member tags

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`subscriber_hash`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

GET/lists/{list_id}/merge-fieldsList merge fields

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`type`	query	no	string
`required`	query	no	boolean

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/lists/{list_id}/merge-fieldsAdd merge field

Parameters

Name	In	Required	Type
`list_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/lists/{list_id}/merge-fields/{merge_id}Get merge field

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`merge_id`	path	yes	string
`exclude_fields`	query	no	array
`fields`	query	no	array

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PATCH/lists/{list_id}/merge-fields/{merge_id}Update merge field

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`merge_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/lists/{list_id}/merge-fields/{merge_id}Delete merge field

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`merge_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

GET/lists/{list_id}/segmentsList segments

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`list_id`	path	yes	string
`type`	query	no	string
`since_created_at`	query	no	string
`before_created_at`	query	no	string
`include_cleaned`	query	no	boolean
`include_transactional`	query	no	boolean
`include_unsubscribed`	query	no	boolean
`since_updated_at`	query	no	string
`before_updated_at`	query	no	string
`exclude_type`	query	no	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/lists/{list_id}/segmentsAdd segment

Parameters

Name	In	Required	Type
`list_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/lists/{list_id}/segments/{segment_id}Get segment info

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`list_id`	path	yes	string
`segment_id`	path	yes	string
`include_cleaned`	query	no	boolean
`include_transactional`	query	no	boolean
`include_unsubscribed`	query	no	boolean

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/lists/{list_id}/segments/{segment_id}Batch add or remove members

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`segment_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PATCH/lists/{list_id}/segments/{segment_id}Update segment

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`segment_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/lists/{list_id}/segments/{segment_id}Delete segment

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`segment_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

GET/lists/{list_id}/segments/{segment_id}/membersList members in segment

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`list_id`	path	yes	string
`segment_id`	path	yes	string
`include_cleaned`	query	no	boolean
`include_transactional`	query	no	boolean
`include_unsubscribed`	query	no	boolean

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/lists/{list_id}/segments/{segment_id}/membersAdd member to segment

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`segment_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/lists/{list_id}/segments/{segment_id}/members/{subscriber_hash}Remove list member from segment

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`segment_id`	path	yes	string
`subscriber_hash`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

GET/lists/{list_id}/signup-formsList signup forms

Parameters

Name	In	Required	Type
`list_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/lists/{list_id}/signup-formsCustomize signup form

Parameters

Name	In	Required	Type
`list_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/lists/{list_id}/surveysGet information about all surveys for a list

Parameters

Name	In	Required	Type
`list_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/lists/{list_id}/surveysCreate survey

Parameters

Name	In	Required	Type
`list_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`	Survey created.	—
`default`	An error generated by the Mailchimp API.	—

GET/lists/{list_id}/surveys/{survey_id}Get survey

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`survey_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PATCH/lists/{list_id}/surveys/{survey_id}Update survey

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`survey_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`	Survey updated.	—
`default`	An error generated by the Mailchimp API.	—

DELETE/lists/{list_id}/surveys/{survey_id}Delete survey

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`survey_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Survey deleted.	—
`default`	An error generated by the Mailchimp API.	—

POST/lists/{list_id}/surveys/{survey_id}/actions/replicateReplicate survey

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`survey_id`	path	yes	string

Request body

application/json

Responses

Status	Description	Schema
`200`	Survey replicated.	—
`default`	An error generated by the Mailchimp API.	—

GET/lists/{list_id}/tag-searchSearch for tags on a list by name.

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`name`	query	no	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/lists/{list_id}/webhooksList webhooks

Parameters

Name	In	Required	Type
`list_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/lists/{list_id}/webhooksAdd webhook

Parameters

Name	In	Required	Type
`list_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/lists/{list_id}/webhooks/{webhook_id}Get webhook info

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`webhook_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PATCH/lists/{list_id}/webhooks/{webhook_id}Update webhook

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`webhook_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/lists/{list_id}/webhooks/{webhook_id}Delete webhook

Parameters

Name	In	Required	Type
`list_id`	path	yes	string
`webhook_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

ping1

GET/pingPing

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

reporting12

GET/reporting/facebook-adsList facebook ads reports

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`sort_field`	query	no	string
`sort_dir`	query	no	string

Responses

Status	Description	Schema
`200`	List of Facebook Ad Report Instances	—
`default`	An error generated by the Mailchimp API.	—

GET/reporting/facebook-ads/{outreach_id}Get facebook ad report

Parameters

Name	In	Required	Type
`fields`	query	no	array
`outreach_id`	path	yes	string
`exclude_fields`	query	no	array

Responses

Status	Description	Schema
`200`	Facebook Ad report Instance	—
`default`	An error generated by the Mailchimp API.	—

GET/reporting/facebook-ads/{outreach_id}/ecommerce-product-activityList facebook ecommerce report

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`outreach_id`	path	yes	string
`sort_field`	query	no	string

Responses

Status	Description	Schema
`200`	Ecommerce Product Activity Instance	—
`default`	An error generated by the Mailchimp API.	—

GET/reporting/landing-pagesList landing pages reports

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer

Responses

Status	Description	Schema
`200`	List of Landing Page Report Instances	—
`default`	An error generated by the Mailchimp API.	—

GET/reporting/landing-pages/{outreach_id}Get landing page report

Parameters

Name	In	Required	Type
`fields`	query	no	array
`outreach_id`	path	yes	string
`exclude_fields`	query	no	array

Responses

Status	Description	Schema
`200`	Landing Page Report Instance	—
`default`	An error generated by the Mailchimp API.	—

GET/reporting/surveysList survey reports

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer

Responses

Status	Description	Schema
`200`	List of Survey Report Instances	—
`default`	An error generated by the Mailchimp API.	—

GET/reporting/surveys/{survey_id}Get survey report

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`survey_id`	path	yes	string

Responses

Status	Description	Schema
`200`	Survey Report Instance	—
`default`	An error generated by the Mailchimp API.	—

GET/reporting/surveys/{survey_id}/questionsList survey question reports

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`survey_id`	path	yes	string

Responses

Status	Description	Schema
`200`	List of Survey Question Report Instances	—
`default`	An error generated by the Mailchimp API.	—

GET/reporting/surveys/{survey_id}/questions/{question_id}Get survey question report

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`survey_id`	path	yes	string
`question_id`	path	yes	string

Responses

Status	Description	Schema
`200`	Survey Question Report Instance	—
`default`	An error generated by the Mailchimp API.	—

GET/reporting/surveys/{survey_id}/questions/{question_id}/answersList answers for question

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`survey_id`	path	yes	string
`question_id`	path	yes	string
`respondent_familiarity_is`	query	no	string

Responses

Status	Description	Schema
`200`	List of Survey Question Answers	—
`default`	An error generated by the Mailchimp API.	—

GET/reporting/surveys/{survey_id}/responsesList survey responses

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`survey_id`	path	yes	string
`answered_question`	query	no	integer
`chose_answer`	query	no	string
`respondent_familiarity_is`	query	no	string

Responses

Status	Description	Schema
`200`	List of survey responses	—
`default`	An error generated by the Mailchimp API.	—

GET/reporting/surveys/{survey_id}/responses/{response_id}Get survey response

Parameters

Name	In	Required	Type
`survey_id`	path	yes	string
`response_id`	path	yes	string

Responses

Status	Description	Schema
`200`	Get a single survey response.	—
`default`	An error generated by the Mailchimp API.	—

reports22

GET/reportsList campaign reports

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`type`	query	no	string
`before_send_time`	query	no	string
`since_send_time`	query	no	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/reports/{campaign_id}Get campaign report

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`campaign_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/reports/{campaign_id}/abuse-reportsList abuse reports

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`campaign_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/reports/{campaign_id}/abuse-reports/{report_id}Get abuse report

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`campaign_id`	path	yes	string
`report_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/reports/{campaign_id}/adviceList campaign feedback

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`campaign_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/reports/{campaign_id}/click-detailsList campaign details

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`campaign_id`	path	yes	string
`sort_field`	query	no	string
`sort_dir`	query	no	string
`filter_bots`	query	no	boolean

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/reports/{campaign_id}/click-details/{link_id}Get campaign link details

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`campaign_id`	path	yes	string
`link_id`	path	yes	string
`filter_bots`	query	no	boolean

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/reports/{campaign_id}/click-details/{link_id}/membersList clicked link subscribers

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`campaign_id`	path	yes	string
`link_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/reports/{campaign_id}/click-details/{link_id}/members/{subscriber_hash}Get clicked link subscriber

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`campaign_id`	path	yes	string
`link_id`	path	yes	string
`subscriber_hash`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/reports/{campaign_id}/domain-performanceList domain performance stats

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`campaign_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/reports/{campaign_id}/ecommerce-product-activityList campaign product activity

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`campaign_id`	path	yes	string
`sort_field`	query	no	string

Responses

Status	Description	Schema
`200`	Ecommerce Product Activity Instance	—
`default`	An error generated by the Mailchimp API.	—

GET/reports/{campaign_id}/eepurlList EepURL activity

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`campaign_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/reports/{campaign_id}/email-activityList email activity

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`campaign_id`	path	yes	string
`since`	query	no	string
`filter_bots`	query	no	boolean

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/reports/{campaign_id}/email-activity/{subscriber_hash}Get subscriber email activity

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`campaign_id`	path	yes	string
`subscriber_hash`	path	yes	string
`since`	query	no	string
`filter_bots`	query	no	boolean

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/reports/{campaign_id}/locationsList top open activities

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`campaign_id`	path	yes	string
`count`	query	no	integer
`offset`	query	no	integer

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/reports/{campaign_id}/open-detailsList campaign open details

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`campaign_id`	path	yes	string
`since`	query	no	string
`sort_field`	query	no	string
`sort_dir`	query	no	string
`filter_bots`	query	no	boolean

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/reports/{campaign_id}/open-details/{subscriber_hash}Get opened campaign subscriber

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`campaign_id`	path	yes	string
`subscriber_hash`	path	yes	string
`filter_bots`	query	no	boolean

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/reports/{campaign_id}/sent-toList campaign recipients

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`campaign_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/reports/{campaign_id}/sent-to/{subscriber_hash}Get campaign recipient info

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`campaign_id`	path	yes	string
`subscriber_hash`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/reports/{campaign_id}/sub-reportsList child campaign reports

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`campaign_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/reports/{campaign_id}/unsubscribedList unsubscribed members

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`campaign_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/reports/{campaign_id}/unsubscribed/{subscriber_hash}Get unsubscribed member

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`campaign_id`	path	yes	string
`subscriber_hash`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

root1

GET/List api root resources

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

searchCampaigns1

GET/search-campaignsSearch campaigns

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`query`	query	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

searchMembers1

GET/search-membersSearch members

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`query`	query	yes	string
`list_id`	query	no	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

sms-campaigns10

GET/sms-campaignsList SMS campaigns

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/sms-campaignsAdd SMS campaign

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/sms-campaigns/{sms_campaign_id}Get SMS campaign info

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`sms_campaign_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PATCH/sms-campaigns/{sms_campaign_id}Update SMS campaign settings

Parameters

Name	In	Required	Type
`sms_campaign_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/sms-campaigns/{sms_campaign_id}Delete SMS campaign

Parameters

Name	In	Required	Type
`sms_campaign_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

POST/sms-campaigns/{sms_campaign_id}/actions/cancel-sendCancel SMS campaign send

Parameters

Name	In	Required	Type
`sms_campaign_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

POST/sms-campaigns/{sms_campaign_id}/actions/scheduleSchedule SMS campaign

Parameters

Name	In	Required	Type
`sms_campaign_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

POST/sms-campaigns/{sms_campaign_id}/actions/sendSend SMS campaign

Parameters

Name	In	Required	Type
`sms_campaign_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

GET/sms-campaigns/{sms_campaign_id}/contentGet SMS campaign content

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`sms_campaign_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PUT/sms-campaigns/{sms_campaign_id}/contentSet SMS campaign content

Parameters

Name	In	Required	Type
`sms_campaign_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

templateFolders5

GET/template-foldersList template folders

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/template-foldersAdd template folder

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/template-folders/{folder_id}Get template folder

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`folder_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PATCH/template-folders/{folder_id}Update template folder

Parameters

Name	In	Required	Type
`folder_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/template-folders/{folder_id}Delete template folder

Parameters

Name	In	Required	Type
`folder_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

templates6

GET/templatesList templates

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`count`	query	no	integer
`offset`	query	no	integer
`created_by`	query	no	string
`since_date_created`	query	no	string
`before_date_created`	query	no	string
`type`	query	no	string
`category`	query	no	string
`folder_id`	query	no	string
`sort_field`	query	no	string
`content_type`	query	no	string
`sort_dir`	query	no	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

POST/templatesAdd template

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

GET/templates/{template_id}Get template info

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`template_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

PATCH/templates/{template_id}Update template

Parameters

Name	In	Required	Type
`template_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/templates/{template_id}Delete template

Parameters

Name	In	Required	Type
`template_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

GET/templates/{template_id}/default-contentView default content

Parameters

Name	In	Required	Type
`fields`	query	no	array
`exclude_fields`	query	no	array
`template_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

verifiedDomains5

GET/verified-domainsList sending domains

Responses

Status	Description	Schema
`200`	The domains on the account.	—
`default`	An error generated by the Mailchimp API.	—

POST/verified-domainsAdd domain to account

Request body

application/json (required)

Responses

Status	Description	Schema
`200`	The newly-created domain.	—
`default`	An error generated by the Mailchimp API.	—

GET/verified-domains/{domain_name}Get domain info

Parameters

Name	In	Required	Type
`domain_name`	path	yes	string

Responses

Status	Description	Schema
`200`		—
`default`	An error generated by the Mailchimp API.	—

DELETE/verified-domains/{domain_name}Delete domain

Parameters

Name	In	Required	Type
`domain_name`	path	yes	string

Responses

Status	Description	Schema
`204`	Empty Response	—
`default`	An error generated by the Mailchimp API.	—

POST/verified-domains/{domain_name}/actions/verifyVerify domain

Parameters

Name	In	Required	Type
`domain_name`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`	The domain being verified for sending.	—
`default`	An error generated by the Mailchimp API.	—

Try it

Operation

API key

Developer reference

Base URLhttps://server.api.mailchimp.com/3.0

Rate limit

The Marketing API caps each account at 10 simultaneous connections -- exceeding that returns a 429. Individual calls are subject to a 120-second execution timeout, and requests judged too complex (e.g. very broad list/report pulls) can have their access throttled rather than a fixed per-minute quota.

Key endpoints

GET/ping
GET/lists
POST/lists
GET/campaigns
GET/reports

SDKs

Node.js ↗PHP ↗Python ↗Ruby ↗

GreatAPIs Score

Embed this badge

Auth quickstart

Endpoints

Try it

Developer reference

People comparing Mailchimp also look at…

Pick an Agency

Gmail

Apache Superset

Freelancer

Google Analytics

Redash