Mailchimp · JSON Structure

Mailchimp Transactional Message Payload Structure

Type: object Properties: 32
CampaignsEmail MarketingMarketing AutomationNewslettersTransactional Email

MessagePayload is a JSON Structure definition published by Mailchimp, describing 32 properties. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.

Properties

html text subject from_email from_name to headers important track_opens track_clicks auto_text auto_html inline_css url_strip_qs preserve_recipients view_content_link bcc_address tracking_domain signing_domain return_path_domain merge merge_language global_merge_vars merge_vars tags subaccount google_analytics_domains google_analytics_campaign metadata recipient_metadata attachments images

Meta-schema: https://json-structure.org/draft/2020-12/schema

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/draft/2020-12/schema",
  "name": "MessagePayload",
  "type": "object",
  "properties": {
    "html": {
      "type": "string"
    },
    "text": {
      "type": "string"
    },
    "subject": {
      "type": "string"
    },
    "from_email": {
      "type": "string"
    },
    "from_name": {
      "type": "string"
    },
    "to": {
      "type": "array"
    },
    "headers": {
      "type": "object"
    },
    "important": {
      "type": "boolean"
    },
    "track_opens": {
      "type": "boolean"
    },
    "track_clicks": {
      "type": "boolean"
    },
    "auto_text": {
      "type": "boolean"
    },
    "auto_html": {
      "type": "boolean"
    },
    "inline_css": {
      "type": "boolean"
    },
    "url_strip_qs": {
      "type": "boolean"
    },
    "preserve_recipients": {
      "type": "boolean"
    },
    "view_content_link": {
      "type": "boolean"
    },
    "bcc_address": {
      "type": "string"
    },
    "tracking_domain": {
      "type": "string"
    },
    "signing_domain": {
      "type": "string"
    },
    "return_path_domain": {
      "type": "string"
    },
    "merge": {
      "type": "boolean"
    },
    "merge_language": {
      "type": "string"
    },
    "global_merge_vars": {
      "type": "array"
    },
    "merge_vars": {
      "type": "array"
    },
    "tags": {
      "type": "array"
    },
    "subaccount": {
      "type": "string"
    },
    "google_analytics_domains": {
      "type": "array"
    },
    "google_analytics_campaign": {
      "type": "string"
    },
    "metadata": {
      "type": "object"
    },
    "recipient_metadata": {
      "type": "array"
    },
    "attachments": {
      "type": "array"
    },
    "images": {
      "type": "array"
    }
  }
}