Mailchimp · Schema

Mailchimp Audience (List)

A Mailchimp audience (also known as a list). Audiences contain subscribers who have opted in to receive correspondence from you or your organization. They hold contact information, segmentation data, campaign defaults, and compliance settings.

CampaignsEmail MarketingMarketing AutomationNewslettersTransactional Email

Properties

Name Type Description
id string A string that uniquely identifies this list.
web_id integer The ID used in the Mailchimp web application.
name string The name of the list/audience.
contact object Contact information displayed in campaign footers to comply with international spam laws.
permission_reminder string The permission reminder for the list, reminding subscribers how they signed up.
use_archive_bar boolean Whether campaigns for this list use the Archive Bar in archives by default.
campaign_defaults object Default values for campaigns created for this list.
notify_on_subscribe string The email address to send subscribe notifications to. Set to empty string to disable.
notify_on_unsubscribe string The email address to send unsubscribe notifications to. Set to empty string to disable.
date_created string The date and time that this list was created in ISO 8601 format.
list_rating integer An auto-generated activity score for the list (0-5).
email_type_option boolean Whether the list supports multiple email formats (HTML and plain-text). When true, subscribers can choose their preferred format.
subscribe_url_short string The URL-shortened version of this list's subscribe form.
subscribe_url_long string The full version of this list's subscribe form URL.
beamer_address string The list's Email Beamer address for creating campaigns via email.
visibility string Legacy visibility setting. No longer used.
double_optin boolean Whether to require the subscriber to confirm subscription via email.
has_welcome boolean Whether this list has a welcome automation connected.
marketing_permissions boolean Whether the list has marketing permissions (GDPR) enabled.
modules array Any list-specific modules installed for this list.
stats object Stats for the list, including subscriber counts and campaign performance.
View JSON Schema on GitHub