Mailchimp

The reply-to email address for the Automation.

The id of the List.

The "from" name for the Automation (not an email address).

The id of the store.

The type of Automation workflow. Currently only supports "abandonedCart".

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A valid URL for the Webhook.

Whether the webhook receives requests or not.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

There are four types of [campaigns](https://mailchimp.com/help/getting-started-with-campaigns/) you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead.

How the campaign"s content is put together. The old drag and drop editor uses "template" while the new editor uses "multichannel". Defaults to template.

The title of the campaign.

Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns.

The campaign"s custom "To" name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/).

Whether to enable e-commerce tracking.

The reply-to email address for the campaign. Note: while this field is not required for campaign creation, it is required for sending.

The title for the card. Typically the subject line of the campaign.

The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes).

The unique list id.

The URL for the RSS feed.

The frequency of the RSS Campaign.

If the campaign is listed in a folder, the id for that folder.

The "from" name on the campaign (not an email address).

Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent.

Automatically inline the CSS included with the campaign content.

Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`.

Automatically append Mailchimp"s [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign.

Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`.

The id of the template to use.

Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns.

Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns.

The preview text for the campaign.

The subject line for the campaign.

An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to.

The url for the header image for the card.

Update contact notes for a campaign based on subscriber email addresses.

Deprecated

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](https://mailchimp.com/help/set-account-defaults/).

A short summary of the campaign to display.

Use Mailchimp Conversation feature to manage out-of-office replies.

The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes).

Update contact notes for a campaign based on subscriber email addresses.

The percentage of recipients to send the test combinations to, must be a value between 10 and 100.

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.

Whether to add CSS to images in the RSS feed to constrain their width in campaigns.

Create a campaign in a connected Salesforce account.

The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used.

The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored.

Segment match type.

The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used.

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.

Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas).

The day of the week to send a weekly RSS Campaign.

The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used.

Sends the daily RSS Campaign on Fridays.

Sends the daily RSS Campaign on Mondays.

Sends the daily RSS Campaign on Sundays.

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.

Sends the daily RSS Campaign on Tuesdays.

Sends the daily RSS Campaign on Saturdays.

Sends the daily RSS Campaign on Thursdays.

Sends the daily RSS Campaign on Wednesdays.

The id for an existing saved segment.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The content of the feedback.

The block id for the editable block that the feedback addresses.

The unique id for the campaign.

The status of feedback.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Name to associate with the folder.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A unique identifier for the cart.

An array of the cart"s line items.

The store id.

The total tax for the cart.

A string that uniquely identifies the campaign for a cart.

The order total for the cart.

The URL for the cart. This parameter is required for [Abandoned Cart](https://mailchimp.com/help/create-an-abandoned-cart-email/) automations.

A unique identifier for the customer. Limited to 50 characters.

The three-letter ISO 4217 code for the currency that the cart uses.

The customer"s company.

The customer"s last name.

The customer"s first name.

The city the customer is located in.

The customer"s email address.

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](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers).

The customer"s country.

The mailing address of the customer.

An additional field for the customer"s mailing address.

The customer"s state name or normalized province.

The customer"s postal or zip code.

The two-letter code for the customer"s country.

The two-letter code for the customer"s province or state.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A unique identifier for the cart line item.

The price of a cart line item.

The id for the cart.

The quantity of a cart line item.

The store id.

A unique identifier for the product associated with the cart line item.

A unique identifier for the product variant associated with the cart line item.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The connected site domain.

The unique identifier for the site.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A unique identifier for the customer. Limited to 50 characters.

The customer"s company.

The store id.

The customer"s last name.

The customer"s first name.

The city the customer is located in.

The customer"s email address.

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](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers).

The customer"s country.

The mailing address of the customer.

An additional field for the customer"s mailing address.

The customer"s state name or normalized province.

The customer"s postal or zip code.

The two-letter code for the customer"s country.

The two-letter code for the customer"s province or state.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The e-mail address at the domain you want to verify. This will receive a two-factor challenge to be used in the verify action.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The name for this type of event ("purchased", "visited", etc). Must be 2-30 characters in length

The unique ID for the list.

Events created with the is_syncing value set to `true` will not trigger automations.

An optional list of properties

The date and time the event occurred in ISO 8601 format.

The MD5 hash of the lowercase version of the list member"s email address. This endpoint also accepts a list member"s email address or contact_id.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The stages of an account export to include.

An ISO 8601 date that will limit the export to only records created after a given time. For instance, the reports stage will contain any campaign sent after the given timestamp. Audiences, however, are excluded from this limit.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The name of the file.

The base64-encoded contents of the file.

The id of the folder.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The name of the folder.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Determines how this category’s interests appear on signup forms.

The text description of this category. This field appears on signup forms and is often phrased as a question.

The unique ID for the list.

The order that the categories are displayed in the list. Lower numbers display first.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The name of the interest. This can be shown publicly on a subscription form.

The unique ID for the list.

The display order for interests.

The unique ID for the interest category.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The name of this landing page.

The type of template the landing page has.

The title of this landing page seen in the browser"s title bar.

The list"s ID associated with this landing page.

The ID of the store associated with this landing page.

The description of this landing page.

The template_id of this landing page.

Will create the Landing Page using the account"s Default List instead of requiring a list_id.

Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/).

Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google"s restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/).

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The name of the list.

The postal or zip code for the list contact.

Whether or not to require the subscriber to confirm subscription via email.

The city for the list contact.

The phone number for the list contact.

The state for the list contact.

Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default.

The company name for the list.

A two-character ISO3166 country code. Defaults to US if invalid.

The street address for the list contact.

The street address for the list contact.

Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). 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.

The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to.

The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list.

Whether or not the list has marketing permissions (eg. GDPR) enabled.

The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to.

The default subject line for campaigns sent to this list.

The default language for this lists"s forms.

The default from name for campaigns sent to this list.

The default from email for campaigns sent to this list.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The content of the note. Note length is limited to 1,000 characters.

The unique ID for the list.

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.

The tags that are associated with a member.

The IP address the subscriber used to confirm their opt-in status.

Subscriber"s current status.

The unique ID for the list.

If set/detected, the [subscriber"s language](https://mailchimp.com/help/view-and-edit-contact-languages/).

The key of this object"s properties is the ID of the interest in question.

IP address the subscriber signed up from.

Type of email this member asked to get ("html" or "text").

A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.

Email address for a subscriber.

The date and time the subscriber confirmed their opt-in status in ISO 8601 format.

The date and time the subscriber signed up for the list in ISO 8601 format.

The location latitude.

The location longitude.

The marketing permissions for the subscriber.

If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique ID for the list.

The unique id for the segment.

Email address for a subscriber.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts).

The name of the merge field (audience field).

The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field.

Whether the merge field is displayed on the signup form.

The unique ID for the list.

Whether the merge field is required to import a contact.

Extra text to help the subscriber fill out the form.

The default value for the merge field if `null`.

The order that the merge field displays on the list signup form.

In a text field, the default length of the text field.

In a radio or dropdown non-group field, the available options for contacts to pick from.

In a date or birthday field, the format of the date.

In a phone field, the phone number type: US or International.

In an address field, the default country code if none supplied.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A unique identifier for the order.

An array of the order"s line items.

The promo codes applied on the order

The store id.

The URL for the order.

The tax total for the order.

A string that uniquely identifies the campaign for an order.

The total for the order.

A unique identifier for the customer. Limited to 50 characters.

The URL for the page where the buyer landed when entering the shop.

A unique identifier for the outreach. Can be an email campaign ID.

The tracking URL associated with the order.

The three-letter ISO 4217 code for the currency that the store accepts.

The Mailchimp tracking code for the order. Uses the "mc_tc" parameter in E-Commerce tracking URLs.

The total amount of the discounts to be applied to the price of the order.

The shipping total for the order.

The tracking number associated with the order.

The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications).

The tracking carrier associated with the order.

The customer"s company.

The fulfillment status for the order. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications).

The date and time the order was updated in ISO 8601 format.

The date and time the order was cancelled in ISO 8601 format. Note: passing a value for this parameter will cancel the order being created.

The customer"s last name.

The date and time the order was processed in ISO 8601 format.

The customer"s first name.

The city in the billing address.

The name associated with the billing address.

The phone number for the billing address

The city the customer is located in.

The city in the order"s shipping address.

The name associated with an order"s shipping address.

The customer"s email address.

The phone number for the order"s shipping address.

The company associated with the billing address.

The country in the billing address.

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](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers).

The billing address for the order.

An additional field for the billing address.

The latitude for the billing address location.

The state or normalized province in the billing address.

The customer"s country.

The company associated with the shipping address.

The country in the shipping address.

The longitude for the billing address location.

The mailing address of the customer.

An additional field for the customer"s mailing address.

The customer"s state name or normalized province.

The shipping address for the order.

An additional field for the shipping address.

The latitude for the shipping address location.

The state or normalized province in the order"s shipping address.

The longitude for the shipping address location.

The postal or zip code in the billing address.

The two-letter code for the country in the billing address.

The customer"s postal or zip code.

The postal or zip code in the shipping address.

The two-letter code for the province in the billing address.

The two-letter code for the customer"s country.

The two-letter code for the country in the shipping address.

The two-letter code for the customer"s province or state.

The two-letter code for the province or state in the shipping address.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A unique identifier for the order line item.

The price of an order line item.

The total discount amount applied to this line item.

The id for the order in a store.

The quantity of an order line item.

The store id.

A unique identifier for the product associated with the order line item.

A unique identifier for the product variant associated with the order line item.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A list of tags assigned to the list member.

The unique ID for the list.

When is_syncing is true, automations based on the tags in the request will not fire

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A unique identifier for the customer. Limited to 50 characters.

The customer"s company.

The store id.

The customer"s last name.

The customer"s first name.

The id for the customer of a store.

The city the customer is located in.

The customer"s email address.

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](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers).

The customer"s country.

The mailing address of the customer.

An additional field for the customer"s mailing address.

The customer"s state name or normalized province.

The customer"s postal or zip code.

The two-letter code for the customer"s country.

The two-letter code for the customer"s province or state.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.

The IP address the subscriber used to confirm their opt-in status.

Subscriber"s current status.

The unique ID for the list.

If set/detected, the [subscriber"s language](https://mailchimp.com/help/view-and-edit-contact-languages/).

The key of this object"s properties is the ID of the interest in question.

IP address the subscriber signed up from.

Type of email this member asked to get ("html" or "text").

A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.

Email address for a subscriber. This value is required only if the email address is not already present on the list.

Subscriber"s status. This value is required only if the email address is not already present on the list.

The date and time the subscriber confirmed their opt-in status in ISO 8601 format.

The MD5 hash of the lowercase version of the list member"s email address. This endpoint also accepts a list member"s email address or contact_id.

The date and time the subscriber signed up for the list in ISO 8601 format.

The location latitude.

The location longitude.

The marketing permissions for the subscriber.

If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A unique identifier for the product variant.

The stock keeping unit (SKU) of a product variant.

The URL for a product variant.

The price of a product variant.

The title of a product variant.

The store id.

The image URL for a product variant.

The backorders of a product variant.

The id for the product of a store.

The id for the product variant.

The visibility of a product variant.

The inventory quantity of a product variant.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A unique identifier for the product.

The URL for a product.

The type of product.

The title of a product.

The handle of a product.

An array of the product"s images.

The vendor for a product.

The store id.

An array of the product"s variants. At least one variant is required for each product. A variant can use the same `id` and `title` as the parent product.

The image URL for a product.

The description of a product.

The date and time the product was published.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A unique identifier for the product image.

The URL for a product image.

The store id.

The id for the product of a store.

The list of product variants using the image.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A unique identifier for the product variant.

The stock keeping unit (SKU) of a product variant.

The URL for a product variant.

The price of a product variant.

The title of a product variant.

The store id.

The image URL for a product variant.

The backorders of a product variant.

The id for the product of a store.

The visibility of a product variant.

The inventory quantity of a product variant.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A unique identifier for the promo code. Restricted to UTF-8 characters with max length 50.

The discount code. Restricted to UTF-8 characters with max length 50.

Whether the promo code is currently enabled.

The store id.

Number of times promo code has been used.

The id for the promo rule of a store.

The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000.

The date and time the promotion was created in ISO 8601 format.

The date and time the promotion was updated in ISO 8601 format.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A unique identifier for the promo rule. If Ecommerce platform does not support promo rule, use promo code id as promo rule id. Restricted to UTF-8 characters with max length 50.

Type of discount. For free shipping set type to fixed.

The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes.

The amount of the promo code discount. If "type" is "fixed", the amount is treated as a monetary value. If "type" is "percentage", amount must be a decimal value between 0.0 and 1.0, inclusive.

The target that the discount applies to.

Whether the promo rule is currently enabled.

The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format.

The store id.

The date and time when the promotion is in effect in ISO 8601 format.

The description of a promotion restricted to UTF-8 characters with max length 255.

The date and time the promotion was created in ISO 8601 format.

The date and time the promotion was updated in ISO 8601 format.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The name of the segment.

The unique ID for the list.

Match type.

An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. Passing an empty array will create a static segment without any subscribers. This field cannot be provided with the options field.

Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas).

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique identifier for the store.

The name of the store.

The store phone number.

The store domain. This parameter is required for Connected Sites and Google Ads.

The unique identifier for the list associated with the store. The `list_id` for a specific store cannot change.

The e-commerce platform of the store.

The timezone for the store.

Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations).

The currency format for the store. For example: `$`, `£`, etc.

The city the store is located in.

The three-letter ISO 4217 code for the currency that the store accepts.

The email address for the store.

The primary locale for the store. For example: `en`, `de`, etc.

The store"s country.

The store"s mailing address.

An additional field for the store"s mailing address.

The latitude of the store location.

The store"s state name or normalized province.

The longitude of the store location.

The store"s postal or zip code.

The two-letter code for to the store"s country.

The two-letter code for the store"s province or state.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique id for the Automation workflow.

The list member"s email address.

The unique id for the Automation workflow email.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The raw HTML for the template. We support the Mailchimp [Template Language](https://mailchimp.com/help/getting-started-with-mailchimps-template-language/) in any HTML code passed via the API.

The name of the template.

The id of the folder the template is currently in.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The name of the folder.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A valid URL for the Webhook.

The unique ID for the list.

Whether the webhook is triggered by actions initiated via the API.

Whether the webhook is triggered by subscriber-initiated actions.

Whether the webhook is triggered by admin-initiated actions in the web interface.

Whether the webhook is triggered when a subscriber"s email address is cleaned from the list.

Whether the webhook is triggered when a subscriber"s profile is updated.

Whether the webhook is triggered when a subscriber"s email address is changed.

Whether the webhook is triggered when a campaign is sent or cancelled.

Whether the webhook is triggered when a list subscriber is added.

Whether the webhook is triggered when a list member unsubscribes.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique id for the Automation workflow.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique ID for the list.

The MD5 hash of the lowercase version of the list member"s email address. This endpoint also accepts a list member"s email address or contact_id.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique ID for the list.

The unique id for the segment.

An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. A maximum of 500 members can be sent.

An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. A maximum of 500 members can be sent.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique ID for the list.

An array of objects, each representing an email address and the subscription status for a specific list. Up to 500 members may be added or updated with each API call.

Whether this batch operation will replace all existing tags with tags in request.

Whether this batch operation will change existing members" subscription status.

If skip_duplicate_check is true, we will ignore duplicates sent in the request when using the batch sub/unsub on the lists endpoint. The status of the first appearance in the request will be saved. This defaults to false.

If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The id for the abuse report.

The unique id for the campaign.

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The unique id for the campaign.

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique id for the campaign.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique ID for the list.

The ID of the survey.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The id for the Step.

The id for the Journey.

The list member"s email address.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

An array of objects, each representing an element style for the signup form.

The unique ID for the list.

The signup form body content.

Header text.

Alt text for the image.

Header image URL.

The URL that the header image will link to.

Image alignment.

Image width, in pixels.

Image height, in pixels.

Image link target.

Image border color.

Image border style.

Image border width.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique id for the batch operation.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique id for the batch webhook.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique id for the campaign.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique id for the campaign.

The unique id for the feedback message.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique id for the campaign folder.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The id for the cart.

The store id.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The id for the cart.

The id for the line item of a cart.

The store id.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique identifier for the site.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The store id.

The id for the customer of a store.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The domain name.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique id for the File Manager file.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique id for the File Manager folder.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique ID for the list.

The unique ID for the interest category.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique ID for the list.

The specific interest or "group name".

The unique ID for the interest category.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique id for the page.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique ID for the list.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique ID for the list.

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique ID for the list.

The id for the merge field.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique ID for the list.

The id for the note.

The MD5 hash of the lowercase version of the list member"s email address. This endpoint also accepts a list member"s email address or contact_id.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The id for the order in a store.

The store id.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The id for the line item of an order.

The id for the order in a store.

The store id.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The store id.

The id for the product of a store.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The id for the product image.

The store id.

The id for the product of a store.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The store id.

The id for the product of a store.

The id for the product variant.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The store id.

The id for the promo code of a store.

The id for the promo rule of a store.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The store id.

The id for the promo rule of a store.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique ID for the list.

The unique id for the segment.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The store id.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique id for the template.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique id for the template folder.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique ID for the list.

The webhook"s id.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique id for the Automation workflow.

The unique id for the Automation workflow email.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The number of records to return. Default value is 10. Maximum value is 1000

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

Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.

The unique ID for the list.

The id for the abuse report.

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The unique id for the account export.

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique id for the connected authorized application.

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

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique id for the Automation workflow.

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

The unique id for the Automation workflow email.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The unique id for the Automation workflow.

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The unique id for the batch operation.

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

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

The unique id for the batch webhook.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The unique id for the campaign.

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The unique id for the campaign.

The unique id for the feedback message.

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The unique id for the campaign folder.

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The unique id for the campaign.

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

Return the `resend_shortcut_eligibility` field in the response, which tells you if the campaign is eligible for the various Campaign Resend Shortcuts offered.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The id for the link.

The unique id for the campaign.

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The unique id for the campaign.

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

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The unique id for the campaign.

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The unique id for the campaign.

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The id for the cart.

The store id.

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The id for the cart.

The id for the line item of a cart.

The store id.

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The id for the link.

The unique id for the campaign.

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

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

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

The unique identifier for the site.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

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

The unique id for the conversation.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The store id.

The id for the customer of a store.

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The domain name.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The outreach id.

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The outreach id.

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The unique id for the File Manager file.

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The unique id for the File Manager folder.

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A specific month of list growth history.

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

The unique ID for the list.

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique ID for the list.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The unique ID for the list.

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

The unique ID for the interest category.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The unique ID for the list.

The specific interest or "group name".

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

The unique ID for the interest category.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The unique id for the page.

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The unique id for the page.

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The outreach id.

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The number of records to return. Default value is 10. Maximum value is 1000

Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The unique ID for the list.

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

Return the total_contacts field in the stats response, which contains an approximate count of all contacts in any state.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The number of records to return. Default value is 10. Maximum value is 1000

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

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

Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.

Determines the order direction for sorted results.

Returns files sorted by the specified field.

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

Restrict results to lists created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

Restrict response to lists created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

Restrict results to lists that contain an active, connected, undeleted ecommerce store.

Return the total_contacts field in the stats response, which contains an approximate count of all contacts in any state.

Restrict results to lists created after the last campaign send date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

Restrict results to lists created before the last campaign send date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not