Mailchimp · Schema
MessagePayload
The message object containing all parameters for a transactional email, including recipients, content, attachments, and tracking options.
CampaignsEmail MarketingMarketing AutomationNewslettersTransactional Email
Properties
| Name | Type | Description |
|---|---|---|
| html | string | The full HTML content of the message. |
| text | string | The full plain-text content of the message. |
| subject | string | The message subject line. |
| from_email | string | The sender email address. |
| from_name | string | The sender display name. |
| to | array | An array of recipient objects. |
| headers | object | Optional extra headers to add to the message (e.g., Reply-To). |
| important | boolean | Whether this message is important and should be delivered ahead of non-important messages. |
| track_opens | boolean | Whether to enable open tracking for this message. |
| track_clicks | boolean | Whether to enable click tracking for this message. |
| auto_text | boolean | Whether to automatically generate a plain-text version from the HTML content. |
| auto_html | boolean | Whether to automatically generate HTML from the plain-text content. |
| inline_css | boolean | Whether to automatically inline all CSS styles from style blocks in the HTML content. |
| url_strip_qs | boolean | Whether to strip query strings from URLs when aggregating tracked click data. |
| preserve_recipients | boolean | Whether to show all recipients in the To header of each email. |
| view_content_link | boolean | Whether to include a View Content Link in the Mandrill dashboard for this message. |
| bcc_address | string | An optional address to BCC on the message. |
| tracking_domain | string | A custom domain to use for tracking opens and clicks. |
| signing_domain | string | A custom domain to use for DKIM signing instead of the default. |
| return_path_domain | string | A custom domain to use for the return-path header. |
| merge | boolean | Whether to evaluate merge tags in the message. |
| merge_language | string | The merge tag language to use (Mailchimp or Handlebars). |
| global_merge_vars | array | Global merge variables applied to all recipients. |
| merge_vars | array | Per-recipient merge variables. |
| tags | array | An array of string tags to apply to this message for analytics. |
| subaccount | string | The unique ID of a subaccount for this message. |
| google_analytics_domains | array | An array of domains for which Google Analytics tracking parameters will be appended. |
| google_analytics_campaign | string | The utm_campaign tracking parameter for Google Analytics. |
| metadata | object | Key-value metadata to associate with the message. |
| recipient_metadata | array | Per-recipient metadata. |
| attachments | array | An array of file attachments. |
| images | array | An array of inline images referenced with "cid:" in the HTML content. |