Mailchimp (version v1.*.*)

store_id (required)

The store id.

Type: string

$body

Information about a specific cart.

Type: object

{
  "checkout_url" : "The URL for the cart. This parameter is required for [Abandoned Cart](http://kb.mailchimp.com/automation/create-an-abandoned-cart-email) automations.",
  "tax_total" : "The total tax for the cart.",
  "order_total" : "The order total for the cart.",
  "id" : "A unique identifier for the cart.",
  "lines" : [ {
    "quantity" : "The quantity of a cart line item.",
    "price" : "The price of a cart line item.",
    "product_id" : "A unique identifier for the product associated with the cart line item.",
    "id" : "A unique identifier for the cart line item.",
    "product_variant_id" : "A unique identifier for the product variant associated with the cart line item."
  } ],
  "campaign_id" : "A string that uniquely identifies the campaign for a cart.",
  "currency_code" : "The three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) code for the currency that the cart uses.",
  "customer" : {
    "total_spent" : "The total amount the customer has spent. [Learn More](http://developer.mailchimp.com/documentation/mailchimp/guides/getting-started-with-ecommerce/#orders_count-and-total_spent) about using this data.",
    "orders_count" : "The customer's total order count. [Learn More](http://developer.mailchimp.com/documentation/mailchimp/guides/getting-started-with-ecommerce/#orders_count-and-total_spent) about using this data.",
    "email_address" : "The customer's email address.",
    "address" : {
      "country" : "The customer's country.",
      "country_code" : "The two-letter code for the customer's country.",
      "province" : "The customer's state name or normalized province.",
      "address2" : "An additional field for the customer's mailing address.",
      "city" : "The city the customer is located in.",
      "address1" : "The mailing address of the customer.",
      "province_code" : "The two-letter code for the customer's province or state.",
      "postal_code" : "The customer's postal or zip code."
    },
    "last_name" : "The customer's last name.",
    "opt_in_status" : "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing MailChimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your MailChimp list [will be added as `Transactional` members](http://developer.mailchimp.com/documentation/mailchimp/guides/getting-started-with-ecommerce/#about-subscribers-and-customers).",
    "company" : "The customer's company.",
    "id" : "A unique identifier for the customer.",
    "first_name" : "The customer's first name."
  }
}

store_id (required)

The store id.

Type: string

$body

Information about a specific customer. Orders for existing customers should include only the id parameter in the customer object body.

Type: object

{
  "total_spent" : "The total amount the customer has spent. [Learn More](http://developer.mailchimp.com/documentation/mailchimp/guides/getting-started-with-ecommerce/#orders_count-and-total_spent) about using this data.",
  "orders_count" : "The customer's total order count. [Learn More](http://developer.mailchimp.com/documentation/mailchimp/guides/getting-started-with-ecommerce/#orders_count-and-total_spent) about using this data.",
  "email_address" : "The customer's email address.",
  "address" : {
    "country" : "The customer's country.",
    "country_code" : "The two-letter code for the customer's country.",
    "province" : "The customer's state name or normalized province.",
    "address2" : "An additional field for the customer's mailing address.",
    "city" : "The city the customer is located in.",
    "address1" : "The mailing address of the customer.",
    "province_code" : "The two-letter code for the customer's province or state.",
    "postal_code" : "The customer's postal or zip code."
  },
  "last_name" : "The customer's last name.",
  "opt_in_status" : "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing MailChimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your MailChimp list [will be added as `Transactional` members](http://developer.mailchimp.com/documentation/mailchimp/guides/getting-started-with-ecommerce/#about-subscribers-and-customers).",
  "company" : "The customer's company.",
  "id" : "A unique identifier for the customer.",
  "first_name" : "The customer's first name."
}

campaign_id (required)

The unique id for the campaign.

Type: string

$body

A specific feedback message from a specific campaign.

Type: object

{
  "is_complete" : "The status of feedback.",
  "message" : "The content of the feedback.",
  "block_id" : "The block id for the editable block that the feedback addresses."
}

interest_category_id (required)

The unique id for the interest category.

Type: string

list_id (required)

The unique id for the list.

Type: string

$body

Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the MailChimp application.

Type: object

{
  "name" : "The name of the interest. This can be shown publicly on a subscription form.",
  "display_order" : "The display order for interests."
}

cart_id (required)

The id for the cart.

Type: string

store_id (required)

The store id.

Type: string

$body

Information about a specific cart line item.

Type: object

{
  "quantity" : "The quantity of a cart line item.",
  "price" : "The price of a cart line item.",
  "product_id" : "A unique identifier for the product associated with the cart line item.",
  "id" : "A unique identifier for the cart line item.",
  "product_variant_id" : "A unique identifier for the product variant associated with the cart line item."
}

order_id (required)

The id for the order in a store.

Type: string

store_id (required)

The store id.

Type: string

$body

Information about a specific order line.

Type: object

{
  "quantity" : "The quantity of an order line item.",
  "price" : "The price of an order line item.",
  "product_id" : "A unique identifier for the product associated with the order line item.",
  "id" : "A unique identifier for the order line item.",
  "product_variant_id" : "A unique identifier for the product variant associated with the order line item."
}

list_id (required)

The unique id for the list.

Type: string

$body

Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed.

Type: object

{
  "email_address" : "Email address for a subscriber.",
  "email_type" : "Type of email this member asked to get ('html' or 'text').",
  "timestamp_opt" : "The date and time the subscribe confirmed their opt-in status.",
  "merge_fields" : { },
  "timestamp_signup" : "The date and time the subscriber signed up for the list.",
  "ip_opt" : "The IP address the subscriber used to confirm their opt-in status.",
  "language" : "If set/detected, the [subscriber's language](http://kb.mailchimp.com/lists/managing-subscribers/view-and-edit-subscriber-languages?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs).",
  "location" : {
    "latitude" : "The location latitude.",
    "longitude" : "The location longitude."
  },
  "ip_signup" : "IP address the subscriber signed up from.",
  "interests" : "The key of this object's properties is the ID of the interest in question.",
  "vip" : "[VIP status](http://kb.mailchimp.com/lists/managing-subscribers/designate-and-send-to-vip-subscribers?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs) for subscriber.",
  "status" : "Subscriber's current status."
}

list_id (required)

The unique id for the list.

Type: string

segment_id (required)

The unique id for the segment.

Type: string

$body

Type: object

{
  "email_address" : "Email address for a subscriber."
}

list_id (required)

The unique id for the list.

Type: string

$body

A merge field (formerly merge vars) for a specific list. These correspond to merge fields in MailChimp's lists and subscriber profiles.

Type: object

{
  "public" : "Whether the merge field is displayed on the signup form.",
  "name" : "The name of the merge field.",
  "display_order" : "The order that the merge field displays on the list signup form.",
  "options" : {
    "size" : "In a text field, the default length of the text field.",
    "date_format" : "In a date or birthday field, the format of the date.",
    "choices" : [ "string" ],
    "default_country" : "In an address field, the default country code if none supplied.",
    "phone_format" : "In a phone field, the phone number type: US or International."
  },
  "default_value" : "The default value for the merge field if `null`.",
  "tag" : "The tag used in MailChimp campaigns and for the /members endpoint.",
  "type" : "The type for the merge field.",
  "required" : "The boolean value if the merge field is required.",
  "help_text" : "Extra text to help the subscriber fill out the form."
}

store_id (required)

The store id.

Type: string

$body

Information about a specific order.

Type: object

{
  "fulfillment_status" : "The fulfillment status for the order. For example: `partial`, `fulfilled`, etc.",
  "tax_total" : "The tax total for the order.",
  "shipping_total" : "The shipping total for the order.",
  "processed_at_foreign" : "The date and time the order was processed.",
  "billing_address" : {
    "country" : "The country in the billing address.",
    "address2" : "An additional field for the billing address.",
    "city" : "The city in the billing address.",
    "address1" : "The billing address for the order.",
    "latitude" : "The latitude for the billing address location.",
    "province_code" : "The two-letter code for the province in the billing address.",
    "country_code" : "The two-letter code for the country in the billing address.",
    "province" : "The state or normalized province in the billing address.",
    "phone" : "The phone number for the billing address",
    "name" : "The name associated with the billing address.",
    "company" : "The company associated with the billing address.",
    "postal_code" : "The postal or zip code in the billing address.",
    "longitude" : "The longitude for the billing address location."
  },
  "tracking_code" : "The MailChimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs.",
  "currency_code" : "The three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) code for the currency that the store accepts.",
  "landing_site" : "The URL for the page where the buyer landed when entering the shop.",
  "financial_status" : "The order status. For example: `refunded`, `processing`, `cancelled`, etc.",
  "order_total" : "The total for the order.",
  "id" : "A unique identifier for the order.",
  "shipping_address" : {
    "country" : "The country in the shipping address.",
    "address2" : "An additional field for the shipping address.",
    "city" : "The city in the order's shipping address.",
    "address1" : "The shipping address for the order.",
    "latitude" : "The latitude for the shipping address location.",
    "province_code" : "The two-letter code for the province or state in the shipping address.",
    "country_code" : "The two-letter code for the country in the shipping address.",
    "province" : "The state or normalized province in the order's shipping address.",
    "phone" : "The phone number for the order's shipping address.",
    "name" : "The name associated with an order's shipping address.",
    "company" : "The company associated with the shipping address.",
    "postal_code" : "The postal or zip code in the shipping address.",
    "longitude" : "The longitude for the shipping address location."
  },
  "updated_at_foreign" : "The date and time the order was updated.",
  "lines" : [ {
    "quantity" : "The quantity of an order line item.",
    "price" : "The price of an order line item.",
    "product_id" : "A unique identifier for the product associated with the order line item.",
    "id" : "A unique identifier for the order line item.",
    "product_variant_id" : "A unique identifier for the product variant associated with the order line item."
  } ],
  "campaign_id" : "A string that uniquely identifies the campaign for an order.",
  "customer" : {
    "total_spent" : "The total amount the customer has spent. [Learn More](http://developer.mailchimp.com/documentation/mailchimp/guides/getting-started-with-ecommerce/#orders_count-and-total_spent) about using this data.",
    "orders_count" : "The customer's total order count. [Learn More](http://developer.mailchimp.com/documentation/mailchimp/guides/getting-started-with-ecommerce/#orders_count-and-total_spent) about using this data.",
    "email_address" : "The customer's email address.",
    "address" : {
      "country" : "The customer's country.",
      "country_code" : "The two-letter code for the customer's country.",
      "province" : "The customer's state name or normalized province.",
      "address2" : "An additional field for the customer's mailing address.",
      "city" : "The city the customer is located in.",
      "address1" : "The mailing address of the customer.",
      "province_code" : "The two-letter code for the customer's province or state.",
      "postal_code" : "The customer's postal or zip code."
    },
    "last_name" : "The customer's last name.",
    "opt_in_status" : "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing MailChimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your MailChimp list [will be added as `Transactional` members](http://developer.mailchimp.com/documentation/mailchimp/guides/getting-started-with-ecommerce/#about-subscribers-and-customers).",
    "company" : "The customer's company.",
    "id" : "A unique identifier for the customer.",
    "first_name" : "The customer's first name."
  },
  "cancelled_at_foreign" : "The date and time the order was cancelled."
}

store_id (required)

The store id.

Type: string

$body

Information about a specific product.

Type: object

{
  "vendor" : "The vendor for a product.",
  "image_url" : "The image URL for a product.",
  "description" : "The description of a product.",
  "handle" : "The handle of a product.",
  "published_at_foreign" : "The date and time the product was published.",
  "id" : "A unique identifier for the product.",
  "variants" : [ {
    "inventory_quantity" : "The inventory quantity of a product variant.",
    "visibility" : "The visibility of a product variant.",
    "backorders" : "The backorders of a product variant.",
    "price" : "The price of a product variant.",
    "image_url" : "The image URL for a product variant.",
    "id" : "A unique identifier for the product variant.",
    "title" : "The title of a product variant.",
    "sku" : "The stock keeping unit (SKU) of a product variant.",
    "url" : "The URL for a product variant."
  } ],
  "title" : "The title of a product.",
  "type" : "The type of product.",
  "url" : "The URL for a product."
}

workflow_email_id (required)

The unique id for the Automation workflow email.

Type: string

workflow_id (required)

The unique id for the Automation workflow.

Type: string

$body

Information about subscribers in an Automation email queue.

Type: object

{
  "email_address" : "The list member's email address."
}

product_id (required)

The id for the product of a store.

Type: string

store_id (required)

The store id.

Type: string

$body

Information about a specific product variant.

Type: object

{
  "inventory_quantity" : "The inventory quantity of a product variant.",
  "visibility" : "The visibility of a product variant.",
  "backorders" : "The backorders of a product variant.",
  "price" : "The price of a product variant.",
  "image_url" : "The image URL for a product variant.",
  "id" : "A unique identifier for the product variant.",
  "title" : "The title of a product variant.",
  "sku" : "The stock keeping unit (SKU) of a product variant.",
  "url" : "The URL for a product variant."
}

list_id (required)

The unique id for the list.

Type: string

$body

Members to subscribe to or unsubscribe from a list.

Type: object

{
  "members" : [ {
    "email_address" : "Email address for a subscriber.",
    "email_type" : "Type of email this member asked to get ('html' or 'text').",
    "timestamp_opt" : "The date and time the subscribe confirmed their opt-in status.",
    "merge_fields" : { },
    "timestamp_signup" : "The date and time the subscriber signed up for the list.",
    "ip_opt" : "The IP address the subscriber used to confirm their opt-in status.",
    "language" : "If set/detected, the [subscriber's language](http://kb.mailchimp.com/lists/managing-subscribers/view-and-edit-subscriber-languages?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs).",
    "location" : {
      "country_code" : "The unique code for the location country.",
      "dstoff" : "The offset for timezones where daylight saving time is observed.",
      "timezone" : "The timezone for the location.",
      "latitude" : "The location latitude.",
      "gmtoff" : "The time difference in hours from GMT.",
      "longitude" : "The location longitude."
    },
    "ip_signup" : "IP address the subscriber signed up from.",
    "interests" : "The key of this object's properties is the ID of the interest in question.",
    "vip" : "[VIP status](http://kb.mailchimp.com/lists/managing-subscribers/designate-and-send-to-vip-subscribers?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs) for subscriber.",
    "status" : "Subscriber's current status."
  } ],
  "update_existing" : "Whether this batch operation will change existing members' subscription status."
}

list_id (required)

The unique id for the list.

Type: string

segment_id (required)

The unique id for the segment.

Type: string

$body

Members to add/remove to/from a static segment

Type: object

{
  "members_to_add" : [ "string" ],
  "members_to_remove" : [ "string" ]
}

campaign_id (required)

The unique id for the campaign.

Type: string

$body

A summary of an individual campaign's settings and content.

Type: object

{
  "settings" : {
    "auto_footer" : "Automatically append MailChimp's [default footer](http://kb.mailchimp.com/campaigns/design/theres-a-gray-footer-added-to-my-campaign?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs) to the campaign.",
    "subject_line" : "The subject line for the campaign.",
    "use_conversation" : "Use MailChimp Conversation feature to manage out-of-office replies.",
    "authenticate" : "Whether MailChimp [authenticated](http://kb.mailchimp.com/delivery/deliverability-research/set-up-mailchimp-authentication?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs) the campaign. Defaults to `true`.",
    "to_name" : "The campaign's custom 'To' name. Typically the first name [merge field](http://kb.mailchimp.com/merge-tags/using/getting-started-with-merge-tags?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs).",
    "title" : "The title of the campaign.",
    "from_name" : "The 'from' name on the campaign (not an email address).",
    "auto_tweet" : "Automatically tweet a link to the [campaign archive](http://kb.mailchimp.com/campaigns/archives/set-up-your-campaign-archive?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs) page when the campaign is sent.",
    "auto_fb_post" : [ "string" ],
    "fb_comments" : "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`.",
    "reply_to" : "The reply-to email address for the campaign.",
    "inline_css" : "Automatically inline the CSS included with the campaign content.",
    "folder_id" : "If the campaign is listed in a folder, the id for that folder."
  },
  "variate_settings" : {
    "send_times" : [ "date-time" ],
    "wait_time" : "The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes.",
    "subject_lines" : [ "string" ],
    "test_size" : "The percentage of recipients to send the test combinations to, must be a value between 10 and 100.",
    "reply_to_addresses" : [ "string" ],
    "winner_criteria" : "The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue—or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the MailChimp web application.",
    "from_names" : [ "string" ]
  },
  "ab_split_opts" : {
    "pick_winner" : "How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'.",
    "wait_time" : "The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent.",
    "wait_units" : "How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent.",
    "subject_b" : "For campaigns split on 'Subject Line', the subject line for Group B.",
    "subject_a" : "For campaigns split on 'Subject Line', the subject line for Group A.",
    "split_test" : "The type of AB split to run.",
    "from_name_a" : "For campaigns split on 'From Name', the name for Group A.",
    "from_name_b" : "For campaigns split on 'From Name', the name for Group B.",
    "send_time_winner" : "The send time for the winning version.",
    "reply_email_b" : "For campaigns split on 'From Name', the reply-to address for Group B.",
    "reply_email_a" : "For campaigns split on 'From Name', the reply-to address for Group A.",
    "send_time_a" : "The send time for Group A.",
    "send_time_b" : "The send time for Group B.",
    "split_size" : "The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50."
  },
  "rss_opts" : {
    "schedule" : {
      "hour" : "The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](http://kb.mailchimp.com/accounts/account-setup/how-to-set-account-defaults?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs).",
      "weekly_send_day" : "The day of the week to send a weekly RSS Campaign.",
      "daily_send" : {
        "sunday" : "Sends the daily RSS Campaign on Sundays.",
        "saturday" : "Sends the daily RSS Campaign on Saturdays.",
        "tuesday" : "Sends the daily RSS Campaign on Tuesdays.",
        "wednesday" : "Sends the daily RSS Campaign on Wednesdays.",
        "thursday" : "Sends the daily RSS Campaign on Thursdays.",
        "friday" : "Sends the daily RSS Campaign on Fridays.",
        "monday" : "Sends the daily RSS Campaign on Mondays."
      },
      "monthly_send_date" : "The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February."
    },
    "constrain_rss_img" : "Whether to add CSS to images in the RSS feed to constrain their width in campaigns.",
    "feed_url" : "The URL for the RSS feed.",
    "frequency" : "The frequency of the RSS Campaign."
  },
  "social_card" : {
    "image_url" : "The url for the header image for the card.",
    "description" : "A short summary of the campaign to display.",
    "title" : "The title for the card. Typically the subject line of the campaign."
  },
  "recipients" : {
    "segment_opts" : {
      "match" : "Segment match type.",
      "saved_segment_id" : "The id for an existing saved segment.",
      "conditions" : [ {
        "op" : "The segment operator.",
        "field" : "The field to segment on.",
        "condition_type" : "The type of segment, for example: date, language, Mandrill, static, and more."
      } ]
    },
    "list_id" : "The unique list id."
  },
  "type" : "There are four types of [campaigns](http://kb.mailchimp.com/campaigns?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs) you can create in MailChimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead.",
  "tracking" : {
    "salesforce" : {
      "notes" : "Update contact notes for a campaign based on subscriber email addresses.",
      "campaign" : "Create a campaign in a connected Salesforce account."
    },
    "highrise" : {
      "notes" : "Update contact notes for a campaign based on subscriber email addresses.",
      "campaign" : "Create a campaign in a connected Highrise account."
    },
    "goal_tracking" : "Whether to enable [Goal](http://kb.mailchimp.com/integrations/other-integrations/integrate-goal-with-mailchimp?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs) tracking.",
    "capsule" : {
      "notes" : "Update contact notes for a campaign based on subscriber email addresses."
    },
    "clicktale" : "The custom slug for [ClickTale](http://kb.mailchimp.com/integrations/other-integrations/additional-tracking-options-for-campaigns?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs#Click-Tale) tracking (max of 50 bytes).",
    "text_clicks" : "Whether to [track clicks](http://kb.mailchimp.com/reports/about-click-tracking?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs) in the plain-text version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns.",
    "ecomm360" : "Whether to enable [eCommerce360](http://kb.mailchimp.com/integrations/other-integrations/about-ecommerce360?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs) tracking.",
    "opens" : "Whether to [track opens](http://kb.mailchimp.com/reports/about-open-tracking?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs). Defaults to `true`. Cannot be set to false for variate campaigns.",
    "google_analytics" : "The custom slug for [Google Analytics](http://kb.mailchimp.com/integrations/other-integrations/integrate-google-analytics-with-mailchimp?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs) tracking (max of 50 bytes).",
    "html_clicks" : "Whether to [track clicks](http://kb.mailchimp.com/reports/about-click-tracking?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs) in the HTML version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
  }
}

$body

A folder used to organize campaigns.

Type: object

{
  "name" : "Name to associate with the folder."
}

list_id (required)

The unique id for the list.

Type: string

$body

Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application.

Type: object

{
  "display_order" : "The order that the categories are displayed in the list. Lower numbers display first.",
  "title" : "The text description of this category. This field appears on signup forms and is often phrased as a question.",
  "type" : "Determines how this category’s interests appear on signup forms."
}

$body

Information about a specific list.

Type: object

{
  "notify_on_subscribe" : "The email address to send [subscribe notifications](http://kb.mailchimp.com/lists/managing-subscribers/change-subscribe-and-unsubscribe-notifications?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs) to.",
  "email_type_option" : "Whether the list supports [multiple formats for emails](http://kb.mailchimp.com/lists/growth/how-to-change-list-name-and-defaults?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs#Change-Subscription-Settings). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup.",
  "permission_reminder" : "The [permission reminder](http://kb.mailchimp.com/accounts/compliance-tips/edit-the-permission-reminder?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs) for the list.",
  "use_archive_bar" : "Whether campaigns for this list use the [Archive Bar](http://kb.mailchimp.com/campaigns/archives/about-the-archive-bar?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs) in archives by default.",
  "notify_on_unsubscribe" : "The email address to send [unsubscribe notifications](http://kb.mailchimp.com/lists/managing-subscribers/change-subscribe-and-unsubscribe-notifications?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs) to.",
  "visibility" : "Whether this list is [public or private](http://kb.mailchimp.com/lists/growth/about-publicity-settings?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs).",
  "contact" : {
    "zip" : "The postal or zip code for the list contact.",
    "country" : "A two-character ISO3166 country code. Defaults to US if invalid.",
    "address2" : "The street address for the list contact.",
    "city" : "The city for the list contact.",
    "phone" : "The phone number for the list contact.",
    "address1" : "The street address for the list contact.",
    "company" : "The company name for the list.",
    "state" : "The state for the list contact."
  },
  "name" : "The name of the list.",
  "campaign_defaults" : {
    "from_email" : "The default from email for campaigns sent to this list.",
    "subject" : "The default subject line for campaigns sent to this list.",
    "language" : "The default language for this lists's forms.",
    "from_name" : "The default from name for campaigns sent to this list."
  }
}

list_id (required)

The unique id for the list.

Type: string

subscriber_hash (required)

The MD5 hash of the lowercase version of the list member's email address.

Type: string

$body

A specific note for a specific member.

Type: object

{
  "email_id" : "The MD5 hash of the lowercase version of the list member's email address.",
  "note" : "The content of the note.",
  "updated_at" : "The date and time the note was last updated.",
  "list_id" : "The unique id for the list.",
  "created_at" : "The date and time the note was created.",
  "id" : "The note id.",
  "created_by" : "The author of the note."
}

list_id (required)

The unique id for the list.

Type: string

$body

Information about a specific list segment.

Type: object

{
  "name" : "The name of the segment.",
  "options" : {
    "match" : "Match type.",
    "conditions" : [ {
      "op" : "The segment operator.",
      "field" : "The field to segment on.",
      "condition_type" : "The type of segment, for example: date, language, Mandrill, static, and more."
    } ]
  },
  "static_segment" : [ "string" ]
}

$body

An individual store in an account.

Type: object

{
  "is_syncing" : "Whether the e-commerce store is currently [syncing](http://developer.mailchimp.com/documentation/mailchimp/guides/getting-started-with-ecommerce/#syncing-an-e-commerce-store).",
  "address" : {
    "country" : "The store's country.",
    "country_code" : "The two-letter code for to the store's country.",
    "province" : "The store's state name or normalized province.",
    "address2" : "An additional field for the store's mailing address.",
    "city" : "The city the store is located in.",
    "address1" : "The store's mailing address.",
    "latitude" : "The latitude of the store location.",
    "province_code" : "The two-letter code for the store's province or state.",
    "postal_code" : "The store's postal or zip code.",
    "longitude" : "The longitude of the store location."
  },
  "list_id" : "The unique identifier for the [MailChimp List](http://developer.mailchimp.com/documentation/mailchimp/reference/lists/) associated with the store. The `list_id` for a specific store cannot change.",
  "timezone" : "The timezone for the store.",
  "primary_locale" : "The primary locale for the store. For example: `en`, `de`, etc.",
  "platform" : "The e-commerce platform of the store.",
  "currency_code" : "The three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) code for the currency that the store accepts.",
  "money_format" : "The currency format for the store. For example: `$`, `£`, etc.",
  "email_address" : "The email address for the store.",
  "phone" : "The store phone number.",
  "domain" : "The store domain.",
  "name" : "The name of the store.",
  "id" : "The unique identifier for the store."
}

$body

Information about a specific template.

Type: object

{
  "name" : "The name of the template.",
  "html" : "The raw HTML for the template. We support the MailChimp [Template Language](http://kb.mailchimp.com/templates/code/getting-started-with-mailchimps-template-language?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs) in any HTML code passed via the API.",
  "folder_id" : "The id of the folder the template is currently in."
}

$body

A folder used to organize templates.

Type: object

{
  "name" : "The name of the folder."
}

list_id (required)

The unique id for the list.

Type: string

$body

Twitter Lead Generation Card.

Type: object

{
  "privacy_policy_url" : "Your site's privacy policy URL. If you don’t have a privacy policy, link to your website’s homepage instead.",
  "twitter_account_id" : "The [Twitter Ads](https://ads.twitter.com/login) account ID.",
  "cta_text" : "Text (up to the 20-character limit) to display on the card's Call-to-Action button.",
  "list_id" : "The unique identifier for the MailChimp list.",
  "image_url" : "A URL for the header image. The image size must be 800 x 200px.",
  "preview_url" : "The Twitter Lead Generation Card Preview URL.",
  "twitter_card_id" : "The Twitter-assigned Lead Generation Card ID.",
  "name" : "The name of the Twitter Lead Generation Card.",
  "custom_key_name" : "A custom key name used to store the Twitter display name of a subscriber.",
  "id" : "The unique MailChimp ID for the Twitter Lead Generation Card.",
  "title" : "The Twitter Lead Generation Card title."
}

list_id (required)

The unique id for the list.

Type: string

$body

Configure a webhook for the given list.

Type: object

{
  "sources" : {
    "admin" : "Whether the webhook is triggered by admin-initiated actions in the web interface.",
    "api" : "Whether the webhook is triggered by actions initiated via the API.",
    "user" : "Whether the webhook is triggered by subscriber-initiated actions."
  },
  "url" : "A valid URL for the Webhook.",
  "events" : {
    "subscribe" : "Whether the webhook is triggered when a list subscriber is added.",
    "unsubscribe" : "Whether the webhook is triggered when a list member unsubscribes.",
    "profile" : "Whether the webhook is triggered when a subscriber's profile is updated.",
    "cleaned" : "Whether the webhook is triggered when a subscriber's email address is cleaned from the list.",
    "campaign" : "Whether the webhook is triggered when a campaign is sent or cancelled.",
    "upemail" : "Whether the webhook is triggered when a subscriber's email address is changed."
  }
}

list_id (required)

The unique id for the list.

Type: string

$body

List signup form.

Type: object

{
  "contents" : [ {
    "section" : "The content section name.",
    "value" : "The content section text."
  } ],
  "header" : {
    "image_height" : "Image height, in pixels.",
    "image_link" : "The URL that the header image will link to.",
    "image_align" : "Image alignment.",
    "image_border_color" : "Image border color.",
    "image_url" : "Header image URL.",
    "image_border_style" : "Image border style.",
    "image_alt" : "Alt text for the image.",
    "text" : "Header text.",
    "image_width" : "Image width, in pixels.",
    "image_target" : "Image link target.",
    "image_border_width" : "Image border width."
  },
  "styles" : [ {
    "options" : [ {
      "property" : "A string that identifies the property.",
      "value" : "A string that identifies value of the property."
    } ],
    "selector" : "A string that identifies the element selector."
  } ]
}

batch_id (required)

The unique id for the batch operation.

Type: string

campaign_id (required)

The unique id for the campaign.

Type: string

folder_id (required)

The unique folder id.

Type: string

cart_id (required)

The id for the cart.

Type: string

store_id (required)

The store id.

Type: string

customer_id (required)

The id for the customer of a store.

Type: string

store_id (required)

The store id.

Type: string

campaign_id (required)

The unique id for the campaign.

Type: string

feedback_id (required)

The unique id for the feedback message.

Type: string

file_id (required)

The unique id for the File Manager file.

Type: string

folder_id (required)

The unique folder id.

Type: string

interest_category_id (required)

The unique id for the interest category.

Type: string

list_id (required)

The unique id for the list.

Type: string

interest_category_id (required)

The unique id for the interest category.

Type: string

interest_id (required)

The specific interest or 'group name'.

Type: string

list_id (required)

The unique id for the list.

Type: string

cart_id (required)

The id for the cart.

Type: string

line_id (required)

The id for the line item.

Type: string

store_id (required)

The store id.

Type: string

line_id (required)

The id for the line item.

Type: string

order_id (required)

The id for the order in a store.

Type: string

store_id (required)

The store id.

Type: string

list_id (required)

The unique id for the list.

Type: string

list_id (required)

The unique id for the list.

Type: string

subscriber_hash (required)

The MD5 hash of the lowercase version of the list member's email address.

Type: string

list_id (required)

The unique id for the list.

Type: string

segment_id (required)

The unique id for the segment.

Type: string

subscriber_hash (required)

The MD5 hash of the lowercase version of the list member's email address.

Type: string

list_id (required)

The unique id for the list.

Type: string

merge_id (required)

The id for the merge field.

Type: string

list_id (required)

The unique id for the list.

Type: string

note_id (required)

The id for the note.

Type: string

subscriber_hash (required)

The MD5 hash of the lowercase version of the list member's email address.

Type: string

order_id (required)

The id for the order in a store.

Type: string

store_id (required)

The store id.

Type: string

product_id (required)

The id for the product of a store.

Type: string

store_id (required)

The store id.

Type: string

list_id (required)

The unique id for the list.

Type: string

segment_id (required)

The unique id for the segment.

Type: string

store_id (required)

The store id.

Type: string

workflow_id (required)

The unique id for the Automation workflow.

Type: string

$body

Information about subscribers in an Automation email queue.

Type: object

{
  "email_address" : "The list member's email address."
}

template_id (required)

The unique id for the template.

Type: string

folder_id (required)

The unique folder id.

Type: string

product_id (required)

The id for the product of a store.

Type: string

store_id (required)

The store id.

Type: string

variant_id (required)

The id for the product variant.

Type: string

list_id (required)

The unique id for the list.

Type: string

webhook_id (required)

The unique ID for the webhook.

Type: string

campaign_id (required)

The unique id for the campaign.

Type: string

report_id (required)

The id for the abuse report.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

list_id (required)

The unique id for the list.

Type: string

report_id (required)

The id for the abuse report.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

app_id (required)

The unique id for the connected authorized application.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

batch_id (required)

The unique id for the batch operation.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

campaign_id (required)

The unique id for the campaign.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

folder_id (required)

The unique folder id.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

cart_id (required)

The id for the cart.

Type: string

store_id (required)

The store id.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

campaign_id (required)

The unique id for the campaign.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

campaign_id (required)

The unique id for the campaign.

Type: string

link_id (required)

The id for the link.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

campaign_id (required)

The unique id for the campaign.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

conversation_id (required)

The unique id for the conversation.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

customer_id (required)

The id for the customer of a store.

Type: string

store_id (required)

The store id.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

template_id (required)

The unique id for the template.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

campaign_id (required)

The unique id for the campaign.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

campaign_id (required)

The unique id for the campaign.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

campaign_id (required)

The unique id for the campaign.

Type: string

subscriber_hash (required)

The MD5 hash of the lowercase version of the list member's email address.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

workflow_email_id (required)

The unique id for the Automation workflow email.

Type: string

workflow_id (required)

The unique id for the Automation workflow.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

campaign_id (required)

The unique id for the campaign.

Type: string

feedback_id (required)

The unique id for the feedback message.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

campaign_id (required)

The unique id for the campaign.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

file_id (required)

The unique id for the File Manager file.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

folder_id (required)

The unique folder id.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

list_id (required)

The unique id for the list.

Type: string

month (required)

A specific month of list growth history.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

list_id (required)

The unique id for the list.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

interest_category_id (required)

The unique id for the interest category.

Type: string

list_id (required)

The unique id for the list.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

interest_category_id (required)

The unique id for the interest category.

Type: string

interest_id (required)

The specific interest or 'group name'.

Type: string

list_id (required)

The unique id for the list.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

cart_id (required)

The id for the cart.

Type: string

line_id (required)

The id for the line item.

Type: string

store_id (required)

The store id.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

line_id (required)

The id for the line item.

Type: string

order_id (required)

The id for the order in a store.

Type: string

store_id (required)

The store id.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

list_id (required)

The unique id for the list.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

list_id (required)

The unique id for the list.

Type: string

subscriber_hash (required)

The MD5 hash of the lowercase version of the list member's email address.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

campaign_id (required)

The unique id for the campaign.

Type: string

link_id (required)

The id for the link.

Type: string

subscriber_hash (required)

The MD5 hash of the lowercase version of the list member's email address.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

list_id (required)

The unique id for the list.

Type: string

subscriber_hash (required)

The MD5 hash of the lowercase version of the list member's email address.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

list_id (required)

The unique id for the list.

Type: string

merge_id (required)

The id for the merge field.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

conversation_id (required)

The unique id for the conversation.

Type: string

message_id (required)

The unique id for the conversation message.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

list_id (required)

The unique id for the list.

Type: string

note_id (required)

The id for the note.

Type: string

subscriber_hash (required)

The MD5 hash of the lowercase version of the list member's email address.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

num

Restrict results to this number of ads (if we have that many. Default is 3.

Type: integer

platform

Restrict results to ads compatible with the given platform. Default is ios

Type: string

order_id (required)

The id for the order in a store.

Type: string

store_id (required)

The store id.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

product_id (required)

The id for the product of a store.

Type: string

store_id (required)

The store id.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

campaign_id (required)

The unique id for the campaign.

Type: string

subscriber_hash (required)

The MD5 hash of the lowercase version of the list member's email address.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

subscriber_hash (required)

The MD5 hash of the lowercase version of the list member's email address.

Type: string

workflow_id (required)

The unique id for the Automation workflow.

Type: string

campaign_id (required)

The unique id for the campaign.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

list_id (required)

The unique id for the list.

Type: string

segment_id (required)

The unique id for the segment.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

campaign_id (required)

The unique id for the campaign.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

store_id (required)

The store id.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

subscriber_hash (required)

The MD5 hash of the lowercase version of the list member's email address.

Type: string

workflow_email_id (required)

The unique id for the Automation workflow email.

Type: string

workflow_id (required)

The unique id for the Automation workflow.

Type: string

template_id (required)

The unique id for the template.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

folder_id (required)

The unique folder id.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

list_id (required)

The unique id for the list.

Type: string

twitter_card_id (required)

The unique ID for the Twitter Lead Generation Card.

Type: string

campaign_id (required)

The unique id for the campaign.

Type: string

subscriber_hash (required)

The MD5 hash of the lowercase version of the list member's email address.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

product_id (required)

The id for the product of a store.

Type: string

store_id (required)

The store id.

Type: string

variant_id (required)

The id for the product variant.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

list_id (required)

The unique id for the list.

Type: string

webhook_id (required)

The unique ID for the webhook.

Type: string

workflow_id (required)

The unique id for the Automation workflow.

Type: string

$body

Use this endpoint to link your application and retrieve OAuth2-based credentials. This is useful if you can't implement the OAuth2 flow but still want to associate calls with your application.

Type: object

{
  "client_secret" : "The client password for authorization.",
  "client_id" : "The client's unique id/username for authorization."
}

campaign_id (required)

The unique id for the campaign.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

list_id (required)

The unique id for the list.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

list_id (required)

The unique id for the list.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

list_id (required)

The unique id for the list.

Type: string

subscriber_hash (required)

The MD5 hash of the lowercase version of the list member's email address.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

before_create_time

Restrict the response to automations created before the set time. We recommend ISO 8601 time format: 2015-10-21T15:41:36+00:00.

Type: date-time

before_send_time

Restrict the response to automations sent before the set time. We recommend ISO 8601 time format: 2015-10-21T15:41:36+00:00.

Type: date-time

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

since_create_time

Restrict the response to automations created after the set time. We recommend ISO 8601 time format: 2015-10-21T15:41:36+00:00.

Type: date-time

since_send_time

Restrict the response to automations sent after the set time. We recommend ISO 8601 time format: 2015-10-21T15:41:36+00:00.

Type: date-time

status

Restrict the results to automations with the specified status.

Type: string

Potential values: save, paused, sending

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

before_create_time

Restrict the response to campaigns created before the set time. We recommend ISO 8601 time format: 2015-10-21T15:41:36+00:00.

Type: date-time

before_send_time

Restrict the response to campaigns sent before the set time. We recommend ISO 8601 time format: 2015-10-21T15:41:36+00:00.

Type: date-time

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

folder_id

The unique folder id.

Type: string

list_id

The unique id for the list.

Type: string

since_create_time

Restrict the response to campaigns created after the set time. We recommend ISO 8601 time format: 2015-10-21T15:41:36+00:00.

Type: date-time

since_send_time

Restrict the response to campaigns sent after the set time. We recommend ISO 8601 time format: 2015-10-21T15:41:36+00:00.

Type: date-time

status

The status of the campaign.

Type: string

Potential values: save, paused, schedule, sending, sent

type

The campaign type.

Type: string

Potential values: regular, plaintext, absplit, rss, variate

store_id (required)

The store id.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

campaign_id

The unique id for the campaign.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

has_unread_messages

Whether the conversation has any unread messages.

Type: string

Potential values: true, false

list_id

The unique id for the list.

Type: string

store_id (required)

The store id.

Type: string

email_address

Restrict the response to customers with the email address.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

campaign_id (required)

The unique id for the campaign.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

workflow_id (required)

The unique id for the Automation workflow.

Type: string

campaign_id (required)

The unique id for the campaign.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

before_created_at

Restrict the response to files created before the set date.

Type: string

created_by

The MailChimp account user who created the File Manager file.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

since_created_at

Restrict the response to files created after the set date.

Type: string

sort_dir

Determines the order direction for sorted results.

Type: string

Potential values: ASC, DESC

sort_field

Returns files sorted by the specified field.

Type: string

Potential values: added_date

type

The file type for the File Manager file.

Type: string

before_created_at

Restrict the response to files created before the set date.

Type: string

created_by

The MailChimp account user who created the File Manager file.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

since_created_at

Restrict the response to files created after the set date.

Type: string

list_id (required)

The unique id for the list.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

type

Restrict results a type of interest group

Type: string

interest_category_id (required)

The unique id for the interest category.

Type: string

list_id (required)

The unique id for the list.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

cart_id (required)

The id for the cart.

Type: string

store_id (required)

The store id.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

order_id (required)

The id for the order in a store.

Type: string

store_id (required)

The store id.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

before_campaign_last_sent

Restrict results to lists created before the last campaign send date.

Type: string

before_date_created

Restrict response to lists created before the set date.

Type: string

email

Restrict results to lists that include a specific subscriber's email address.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

since_campaign_last_sent

Restrict results to lists created after the last campaign send date.

Type: string

since_date_created

Restrict results to lists created after the set date.

Type: string

campaign_id (required)

The unique id for the campaign.

Type: string

link_id (required)

The id for the link.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

list_id (required)

The unique id for the list.

Type: string

before_last_changed

Restrict results to subscribers whose information changed before the set timeframe.

Type: string

before_timestamp_opt

Restrict results to subscribers who opted-in before the set timeframe.

Type: string

email_type

The email type.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

interest_category_id

The unique id for the interest category.

Type: string

interest_ids

Used to filter list members by interests. Must be accompanied by interest_category_id and interest_match. The value must be a comma separated list of interest ids present for the given interest category.

Type: string

interest_match

Used to filter list members by interests. Must be accompanied by interest_category_id and interest_ids. "any" will match a member with any of the interest supplied, "all" will only match members with every interest supplied, and "none" will match members without any of the interest supplied.

Type: string

Potential values: any, all, none

since_last_changed

Restrict results to subscribers whose information changed after the set timeframe.

Type: string

since_timestamp_opt

Restrict results to subscribers who opted-in after the set timeframe.

Type: string

status

The subscriber's status.

Type: string

unique_email_id

A unique identifier for the email address across all MailChimp lists. This parameter can be found in any links with Ecommerce Tracking enabled.

Type: string

vip_only

A filter to return only the list's VIP members. Passing true will restrict results to VIP list members, passing false will return all list members.

Type: boolean

list_id (required)

The unique id for the list.

Type: string

segment_id (required)

The unique id for the segment.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

list_id (required)

The unique id for the list.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

required

The boolean value if the merge field is required.

Type: boolean

type

The merge field type.

Type: string

conversation_id (required)

The unique id for the conversation.

Type: string

before_timestamp

Restrict the response to messages created before the set time. We recommend ISO 8601 time format: 2015-10-21T15:41:36+00:00.

Type: date-time

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

is_read

Whether a conversation message has been marked as read.

Type: string

Potential values: true, false

since_timestamp

Restrict the response to messages created after the set time. We recommend ISO 8601 time format: 2015-10-21T15:41:36+00:00.

Type: date-time

list_id (required)

The unique id for the list.

Type: string

subscriber_hash (required)

The MD5 hash of the lowercase version of the list member's email address.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

store_id (required)

The store id.

Type: string

campaign_id

Restrict results to orders with a specific campaign_id value.

Type: string

customer_id

Restrict results to orders made by a specific customer.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

fields

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]

store_id (required)

The store id.

Type: string

exclude_fields

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Type: array

[ "string" ]