NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Mailchimp

mailchimp

Mailchimp is an email marketing and automation platform providing campaign templates, audience segmentation, and performance analytics to drive engagement and conversions

Email NewslettersMarketing AutomationWeb del proveedor
Acciones
271
Triggers
4
Autenticación
—
OAuth gestionado
Sí
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (271)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Add automationMAILCHIMP_ADD_AUTOMATIONAcción

Create a new classic automation in your mailchimp account.

Parámetros de entrada

  • settings__reply__tostring

    The reply-to email address for the Automation.

  • recipients__list__idstring

    The id of the List.

  • settings__from__namestring

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

  • recipients__store__idstring

    The id of the store.

  • trigger__settings__workflow__typestring

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add batch webhookMAILCHIMP_ADD_BATCH_WEBHOOKAcción

Configure a webhook that will fire whenever any batch request completes processing. you may only have a maximum of 20 batch webhooks.

Parámetros de entrada

  • urlstringObligatorio

    A valid URL for the Webhook.

  • enabledboolean

    Whether the webhook receives requests or not.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add campaignMAILCHIMP_ADD_CAMPAIGNAcción

Create a new mailchimp campaign.

Parámetros de entrada

  • typestringObligatorioenum

    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.

    regularplaintextabsplitrssvariate
  • content_typestringenum

    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.

    templatemultichannel
  • settings__titlestring

    The title of the campaign.

  • tracking__opensboolean

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

  • settings__to__namestring

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

  • tracking__ecomm360boolean

    Whether to enable e-commerce tracking.

  • settings__reply__tostring

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

  • social__card__titlestring

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

  • tracking__clicktalestring

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

  • recipients__list__idstring

    The unique list id.

  • rss__opts__feed__urlstringuri

    The URL for the RSS feed.

  • rss__opts__frequencystringenum

    The frequency of the RSS Campaign.

    dailyweeklymonthly
  • settings__folder__idstring

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

  • settings__from__namestring

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

  • settings__auto__tweetboolean

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

  • settings__inline__cssboolean

    Automatically inline the CSS included with the campaign content.

  • settings__authenticateboolean

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

  • settings__auto__footerboolean

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

  • settings__fb__commentsboolean

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

  • settings__template__idinteger

    The id of the template to use.

  • tracking__html__clicksboolean

    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.

  • tracking__text__clicksboolean

    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.

  • settings__preview__textstring

    The preview text for the campaign.

  • settings__subject__linestring

    The subject line for the campaign.

  • settings__auto__fb__poststring[]

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

  • social__card__image__urlstring

    The url for the header image for the card.

  • tracking__capsule__notesboolean

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

  • tracking__goal__trackingboolean

    Deprecated

  • rss__opts__schedule__hourinteger

    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/).

  • social__card__descriptionstring

    A short summary of the campaign to display.

  • settings__use__conversationboolean

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

  • tracking__google__analyticsstring

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

  • tracking__salesforce__notesboolean

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

  • variate__settings__test__sizeinteger

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

  • variate__settings__wait__timeinteger

    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.

  • rss__opts__constrain__rss__imgboolean

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

  • tracking__salesforce__campaignboolean

    Create a campaign in a connected Salesforce account.

  • variate__settings__from__namesstring[]

    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.

  • variate__settings__send__timesstring[]

    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.

  • recipients__segment__opts__matchstringenum

    Segment match type.

    anyall
  • variate__settings__subject__linesstring[]

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

  • variate__settings__winner__criteriastringenum

    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.

    opensclicksmanualtotal_revenue
  • recipients__segment__opts__conditionsobject[]

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

  • rss__opts__schedule__weekly__send__daystringenum

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

    sundaymondaytuesdaywednesdaythursdayfridaysaturday
  • variate__settings__reply__to__addressesstring[]

    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.

  • rss__opts__schedule__daily__send__fridayboolean

    Sends the daily RSS Campaign on Fridays.

  • rss__opts__schedule__daily__send__mondayboolean

    Sends the daily RSS Campaign on Mondays.

  • rss__opts__schedule__daily__send__sundayboolean

    Sends the daily RSS Campaign on Sundays.

  • rss__opts__schedule__monthly__send__dateinteger

    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.

  • rss__opts__schedule__daily__send__tuesdayboolean

    Sends the daily RSS Campaign on Tuesdays.

  • rss__opts__schedule__daily__send__saturdayboolean

    Sends the daily RSS Campaign on Saturdays.

  • rss__opts__schedule__daily__send__thursdayboolean

    Sends the daily RSS Campaign on Thursdays.

  • rss__opts__schedule__daily__send__wednesdayboolean

    Sends the daily RSS Campaign on Wednesdays.

  • recipients__segment__opts__saved__segment__idinteger

    The id for an existing saved segment.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add campaign feedbackMAILCHIMP_ADD_CAMPAIGN_FEEDBACKAcción

Add feedback on a specific campaign.

Parámetros de entrada

  • messagestringObligatorio

    The content of the feedback.

  • block_idinteger

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

  • campaign_idstringObligatorio

    The unique id for the campaign.

  • is_completeboolean

    The status of feedback.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add campaign folderMAILCHIMP_ADD_CAMPAIGN_FOLDERAcción

Create a new campaign folder.

Parámetros de entrada

  • namestringObligatorio

    Name to associate with the folder.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add cartMAILCHIMP_ADD_CARTAcción

Add a new cart to a store.

Parámetros de entrada

  • idstringObligatorio

    A unique identifier for the cart.

  • linesobject[]Obligatorio

    An array of the cart"s line items.

  • store_idstringObligatorio

    The store id.

  • tax_totalinteger

    The total tax for the cart.

  • campaign_idstring

    A string that uniquely identifies the campaign for a cart.

  • order_totalintegerObligatorio

    The order total for the cart.

  • checkout_urlstring

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

  • customer__idstring

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

  • currency_codestringObligatorio

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

  • customer__companystring

    The customer"s company.

  • customer__last__namestring

    The customer"s last name.

  • customer__first__namestring

    The customer"s first name.

  • customer__address__citystring

    The city the customer is located in.

  • customer__email__addressstring

    The customer"s email address.

  • customer__opt__in__statusboolean

    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).

  • customer__address__countrystring

    The customer"s country.

  • customer__address__address1string

    The mailing address of the customer.

  • customer__address__address2string

    An additional field for the customer"s mailing address.

  • customer__address__provincestring

    The customer"s state name or normalized province.

  • customer__address__postal__codestring

    The customer"s postal or zip code.

  • customer__address__country__codestring

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

  • customer__address__province__codestring

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add cart line itemMAILCHIMP_ADD_CART_LINE_ITEMAcción

Add a new line item to an existing cart.

Parámetros de entrada

  • idstringObligatorio

    A unique identifier for the cart line item.

  • priceintegerObligatorio

    The price of a cart line item.

  • cart_idstringObligatorio

    The id for the cart.

  • quantityintegerObligatorio

    The quantity of a cart line item.

  • store_idstringObligatorio

    The store id.

  • product_idstringObligatorio

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

  • product_variant_idstringObligatorio

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add connected siteMAILCHIMP_ADD_CONNECTED_SITEAcción

Create a new mailchimp connected site.

Parámetros de entrada

  • domainstringObligatorio

    The connected site domain.

  • foreign_idstringObligatorio

    The unique identifier for the site.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add customerMAILCHIMP_ADD_CUSTOMERAcción

Add a new customer to a store.

Parámetros de entrada

  • idstringObligatorio

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

  • companystring

    The customer"s company.

  • store_idstringObligatorio

    The store id.

  • last_namestring

    The customer"s last name.

  • first_namestring

    The customer"s first name.

  • address__citystring

    The city the customer is located in.

  • email_addressstringObligatorio

    The customer"s email address.

  • opt_in_statusbooleanObligatorio

    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).

  • address__countrystring

    The customer"s country.

  • address__address1string

    The mailing address of the customer.

  • address__address2string

    An additional field for the customer"s mailing address.

  • address__provincestring

    The customer"s state name or normalized province.

  • address__postal__codestring

    The customer"s postal or zip code.

  • address__country__codestring

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

  • address__province__codestring

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add domain to accountMAILCHIMP_ADD_DOMAIN_TO_ACCOUNTAcción

Add a domain to the account.

Parámetros de entrada

  • verification_emailstringObligatorio

    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.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add eventMAILCHIMP_ADD_EVENTAcción

Add an event for a list member.

Parámetros de entrada

  • namestringObligatorio

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

  • list_idstringObligatorio

    The unique ID for the list.

  • is_syncingboolean

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

  • propertiesobject

    An optional list of properties

  • occurred_atstringdate-time

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

  • subscriber_hashstringObligatorio

    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.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add exportMAILCHIMP_ADD_EXPORTAcción

Create a new account export in your mailchimp account.

Parámetros de entrada

  • include_stagesstring[]Obligatorio

    The stages of an account export to include.

  • since_timestampstringdate-time

    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.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add fileMAILCHIMP_ADD_FILEAcción

Upload a new image or file to the file manager.

Parámetros de entrada

  • namestringObligatorio

    The name of the file.

  • file_datastringObligatorio

    The base64-encoded contents of the file.

  • folder_idinteger

    The id of the folder.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add folderMAILCHIMP_ADD_FOLDERAcción

Create a new folder in the file manager.

Parámetros de entrada

  • namestringObligatorio

    The name of the folder.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add interest categoryMAILCHIMP_ADD_INTEREST_CATEGORYAcción

Create a new interest category.

Parámetros de entrada

  • typestringObligatorioenum

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

    checkboxesdropdownradiohidden
  • titlestringObligatorio

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

  • list_idstringObligatorio

    The unique ID for the list.

  • display_orderinteger

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add interest in categoryMAILCHIMP_ADD_INTEREST_IN_CATEGORYAcción

Create a new interest or 'group name' for a specific category.

Parámetros de entrada

  • namestringObligatorio

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

  • list_idstringObligatorio

    The unique ID for the list.

  • display_orderinteger

    The display order for interests.

  • interest_category_idstringObligatorio

    The unique ID for the interest category.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add landing pageMAILCHIMP_ADD_LANDING_PAGEAcción

Create a new mailchimp landing page.

Parámetros de entrada

  • namestring

    The name of this landing page.

  • typestringenum

    The type of template the landing page has.

    signupproduct
  • titlestring

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

  • list_idstring

    The list"s ID associated with this landing page.

  • store_idstring

    The ID of the store associated with this landing page.

  • descriptionstring

    The description of this landing page.

  • template_idinteger

    The template_id of this landing page.

  • use_default_listboolean

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

  • tracking__track__with__mailchimpboolean

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

  • tracking__enable__restricted__data__processingboolean

    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/).

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add listMAILCHIMP_ADD_LISTAcción

Create a new list in your mailchimp account.

Parámetros de entrada

  • namestringObligatorio

    The name of the list.

  • contact__zipstring

    The postal or zip code for the list contact.

  • double_optinboolean

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

  • contact__citystring

    The city for the list contact.

  • contact__phonestring

    The phone number for the list contact.

  • contact__statestring

    The state for the list contact.

  • use_archive_barboolean

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

  • contact__companystring

    The company name for the list.

  • contact__countrystring

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

  • contact__address1string

    The street address for the list contact.

  • contact__address2string

    The street address for the list contact.

  • email_type_optionbooleanObligatorio

    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.

  • notify_on_subscribestring

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

  • permission_reminderstringObligatorio

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

  • marketing_permissionsboolean

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

  • notify_on_unsubscribestring

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

  • campaign__defaults__subjectstring

    The default subject line for campaigns sent to this list.

  • campaign__defaults__languagestring

    The default language for this lists"s forms.

  • campaign__defaults__from__namestring

    The default from name for campaigns sent to this list.

  • campaign__defaults__from__emailstring

    The default from email for campaigns sent to this list.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add member noteMAILCHIMP_ADD_MEMBER_NOTEAcción

Add a new note for a specific subscriber.

Parámetros de entrada

  • notestring

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

  • list_idstringObligatorio

    The unique ID for the list.

  • subscriber_hashstringObligatorio

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add member to listMAILCHIMP_ADD_MEMBER_TO_LISTAcción

Add a new member to the list.

Parámetros de entrada

  • vipboolean

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

  • tagsstring[]

    The tags that are associated with a member.

  • ip_optstring

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

  • statusstringObligatorioenum

    Subscriber"s current status.

    subscribedunsubscribedcleanedpendingtransactional
  • list_idstringObligatorio

    The unique ID for the list.

  • languagestring

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

  • interestsobject

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

  • ip_signupstring

    IP address the subscriber signed up from.

  • email_typestring

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

  • merge_fieldsobject

    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_addressstringObligatorio

    Email address for a subscriber.

  • timestamp_optstringdate-time

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

  • timestamp_signupstringdate-time

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

  • location__latitudeinteger

    The location latitude.

  • location__longitudeinteger

    The location longitude.

  • marketing_permissionsobject[]

    The marketing permissions for the subscriber.

  • skip_merge_validationboolean

    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.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add member to segmentMAILCHIMP_ADD_MEMBER_TO_SEGMENTAcción

Add a member to a static segment.

Parámetros de entrada

  • list_idstringObligatorio

    The unique ID for the list.

  • segment_idstringObligatorio

    The unique id for the segment.

  • email_addressstringObligatorio

    Email address for a subscriber.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add merge fieldMAILCHIMP_ADD_MERGE_FIELDAcción

Add a new merge field for a specific audience.

Parámetros de entrada

  • tagstring

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

  • namestringObligatorio

    The name of the merge field (audience field).

  • typestringObligatorioenum

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

    textnumberaddressphonedateurlimageurlradiodropdownbirthdayzip
  • publicboolean

    Whether the merge field is displayed on the signup form.

  • list_idstringObligatorio

    The unique ID for the list.

  • requiredboolean

    Whether the merge field is required to import a contact.

  • help_textstring

    Extra text to help the subscriber fill out the form.

  • default_valuestring

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

  • display_orderinteger

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

  • options__sizeinteger

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

  • options__choicesstring[]

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

  • options__date__formatstring

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

  • options__phone__formatstring

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

  • options__default__countryinteger

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add orderMAILCHIMP_ADD_ORDERAcción

Add a new order to a store.

Parámetros de entrada

  • idstringObligatorio

    A unique identifier for the order.

  • linesobject[]Obligatorio

    An array of the order"s line items.

  • promosobject[]

    The promo codes applied on the order

  • store_idstringObligatorio

    The store id.

  • order_urlstring

    The URL for the order.

  • tax_totalinteger

    The tax total for the order.

  • campaign_idstring

    A string that uniquely identifies the campaign for an order.

  • order_totalintegerObligatorio

    The total for the order.

  • customer__idstring

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

  • landing_sitestring

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

  • outreach__idstring

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

  • tracking_urlstring

    The tracking URL associated with the order.

  • currency_codestringObligatorio

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

  • tracking_codestringenum

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

    prec
  • discount_totalinteger

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

  • shipping_totalinteger

    The shipping total for the order.

  • tracking_numberstring

    The tracking number associated with the order.

  • financial_statusstring

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

  • tracking_carrierstring

    The tracking carrier associated with the order.

  • customer__companystring

    The customer"s company.

  • fulfillment_statusstring

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

  • updated_at_foreignstringdate-time

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

  • cancelled_at_foreignstringdate-time

    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.

  • customer__last__namestring

    The customer"s last name.

  • processed_at_foreignstringdate-time

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

  • customer__first__namestring

    The customer"s first name.

  • billing__address__citystring

    The city in the billing address.

  • billing__address__namestring

    The name associated with the billing address.

  • billing__address__phonestring

    The phone number for the billing address

  • customer__address__citystring

    The city the customer is located in.

  • shipping__address__citystring

    The city in the order"s shipping address.

  • shipping__address__namestring

    The name associated with an order"s shipping address.

  • customer__email__addressstring

    The customer"s email address.

  • shipping__address__phonestring

    The phone number for the order"s shipping address.

  • billing__address__companystring

    The company associated with the billing address.

  • billing__address__countrystring

    The country in the billing address.

  • customer__opt__in__statusboolean

    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).

  • billing__address__address1string

    The billing address for the order.

  • billing__address__address2string

    An additional field for the billing address.

  • billing__address__latitudeinteger

    The latitude for the billing address location.

  • billing__address__provincestring

    The state or normalized province in the billing address.

  • customer__address__countrystring

    The customer"s country.

  • shipping__address__companystring

    The company associated with the shipping address.

  • shipping__address__countrystring

    The country in the shipping address.

  • billing__address__longitudeinteger

    The longitude for the billing address location.

  • customer__address__address1string

    The mailing address of the customer.

  • customer__address__address2string

    An additional field for the customer"s mailing address.

  • customer__address__provincestring

    The customer"s state name or normalized province.

  • shipping__address__address1string

    The shipping address for the order.

  • shipping__address__address2string

    An additional field for the shipping address.

  • shipping__address__latitudeinteger

    The latitude for the shipping address location.

  • shipping__address__provincestring

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

  • shipping__address__longitudeinteger

    The longitude for the shipping address location.

  • billing__address__postal__codestring

    The postal or zip code in the billing address.

  • billing__address__country__codestring

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

  • customer__address__postal__codestring

    The customer"s postal or zip code.

  • shipping__address__postal__codestring

    The postal or zip code in the shipping address.

  • billing__address__province__codestring

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

  • customer__address__country__codestring

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

  • shipping__address__country__codestring

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

  • customer__address__province__codestring

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

  • shipping__address__province__codestring

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add order line itemMAILCHIMP_ADD_ORDER_LINE_ITEMAcción

Add a new line item to an existing order.

Parámetros de entrada

  • idstringObligatorio

    A unique identifier for the order line item.

  • priceintegerObligatorio

    The price of an order line item.

  • discountinteger

    The total discount amount applied to this line item.

  • order_idstringObligatorio

    The id for the order in a store.

  • quantityintegerObligatorio

    The quantity of an order line item.

  • store_idstringObligatorio

    The store id.

  • product_idstringObligatorio

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

  • product_variant_idstringObligatorio

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add or remove member tagsMAILCHIMP_ADD_OR_REMOVE_MEMBER_TAGSAcción

Add or remove tags from a list member. if a tag that does not exist is passed in and set as 'active', a new tag will be created.

Parámetros de entrada

  • tagsobject[]Obligatorio

    A list of tags assigned to the list member.

  • list_idstringObligatorio

    The unique ID for the list.

  • is_syncingboolean

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

  • subscriber_hashstringObligatorio

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add or update customerMAILCHIMP_ADD_OR_UPDATE_CUSTOMERAcción

Add or update a customer.

Parámetros de entrada

  • idstringObligatorio

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

  • companystring

    The customer"s company.

  • store_idstringObligatorio

    The store id.

  • last_namestring

    The customer"s last name.

  • first_namestring

    The customer"s first name.

  • customer_idstringObligatorio

    The id for the customer of a store.

  • address__citystring

    The city the customer is located in.

  • email_addressstringObligatorio

    The customer"s email address.

  • opt_in_statusbooleanObligatorio

    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).

  • address__countrystring

    The customer"s country.

  • address__address1string

    The mailing address of the customer.

  • address__address2string

    An additional field for the customer"s mailing address.

  • address__provincestring

    The customer"s state name or normalized province.

  • address__postal__codestring

    The customer"s postal or zip code.

  • address__country__codestring

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

  • address__province__codestring

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add or update list memberMAILCHIMP_ADD_OR_UPDATE_LIST_MEMBERAcción

Add or update a list member.

Parámetros de entrada

  • vipboolean

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

  • ip_optstring

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

  • statusstringenum

    Subscriber"s current status.

    subscribedunsubscribedcleanedpendingtransactional
  • list_idstringObligatorio

    The unique ID for the list.

  • languagestring

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

  • interestsobject

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

  • ip_signupstring

    IP address the subscriber signed up from.

  • email_typestring

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

  • merge_fieldsobject

    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_addressstringObligatorio

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

  • status_if_newstringObligatorioenum

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

    subscribedunsubscribedcleanedpendingtransactional
  • timestamp_optstringdate-time

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

  • subscriber_hashstringObligatorio

    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.

  • timestamp_signupstringdate-time

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

  • location__latitudeinteger

    The location latitude.

  • location__longitudeinteger

    The location longitude.

  • marketing_permissionsobject[]

    The marketing permissions for the subscriber.

  • skip_merge_validationboolean

    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.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add or update product variantMAILCHIMP_ADD_OR_UPDATE_PRODUCT_VARIANTAcción

Add or update a product variant.

Parámetros de entrada

  • idstringObligatorio

    A unique identifier for the product variant.

  • skustring

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

  • urlstring

    The URL for a product variant.

  • priceinteger

    The price of a product variant.

  • titlestringObligatorio

    The title of a product variant.

  • store_idstringObligatorio

    The store id.

  • image_urlstring

    The image URL for a product variant.

  • backordersstring

    The backorders of a product variant.

  • product_idstringObligatorio

    The id for the product of a store.

  • variant_idstringObligatorio

    The id for the product variant.

  • visibilitystring

    The visibility of a product variant.

  • inventory_quantityinteger

    The inventory quantity of a product variant.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add productMAILCHIMP_ADD_PRODUCTAcción

Add a new product to a store.

Parámetros de entrada

  • idstringObligatorio

    A unique identifier for the product.

  • urlstring

    The URL for a product.

  • typestring

    The type of product.

  • titlestringObligatorio

    The title of a product.

  • handlestring

    The handle of a product.

  • imagesobject[]

    An array of the product"s images.

  • vendorstring

    The vendor for a product.

  • store_idstringObligatorio

    The store id.

  • variantsobject[]Obligatorio

    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.

  • image_urlstring

    The image URL for a product.

  • descriptionstring

    The description of a product.

  • published_at_foreignstringdate-time

    The date and time the product was published.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add product imageMAILCHIMP_ADD_PRODUCT_IMAGEAcción

Add a new image to the product.

Parámetros de entrada

  • idstringObligatorio

    A unique identifier for the product image.

  • urlstringObligatorio

    The URL for a product image.

  • store_idstringObligatorio

    The store id.

  • product_idstringObligatorio

    The id for the product of a store.

  • variant_idsstring[]

    The list of product variants using the image.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add product variantMAILCHIMP_ADD_PRODUCT_VARIANTAcción

Add a new variant to the product.

Parámetros de entrada

  • idstringObligatorio

    A unique identifier for the product variant.

  • skustring

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

  • urlstring

    The URL for a product variant.

  • priceinteger

    The price of a product variant.

  • titlestringObligatorio

    The title of a product variant.

  • store_idstringObligatorio

    The store id.

  • image_urlstring

    The image URL for a product variant.

  • backordersstring

    The backorders of a product variant.

  • product_idstringObligatorio

    The id for the product of a store.

  • visibilitystring

    The visibility of a product variant.

  • inventory_quantityinteger

    The inventory quantity of a product variant.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add promo codeMAILCHIMP_ADD_PROMO_CODEAcción

Add a new promo code to a store.

Parámetros de entrada

  • idstringObligatorio

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

  • codestringObligatorio

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

  • enabledboolean

    Whether the promo code is currently enabled.

  • store_idstringObligatorio

    The store id.

  • usage_countinteger

    Number of times promo code has been used.

  • promo_rule_idstringObligatorio

    The id for the promo rule of a store.

  • redemption_urlstringObligatorio

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

  • created_at_foreignstringdate-time

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

  • updated_at_foreignstringdate-time

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add promo ruleMAILCHIMP_ADD_PROMO_RULEAcción

Add a new promo rule to a store.

Parámetros de entrada

  • idstringObligatorio

    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.

  • typestringObligatorioenum

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

    fixedpercentage
  • titlestring

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

  • amountintegerObligatorio

    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.

  • targetstringObligatorioenum

    The target that the discount applies to.

    per_itemtotalshipping
  • enabledboolean

    Whether the promo rule is currently enabled.

  • ends_atstringPromo date-time

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

  • store_idstringObligatorio

    The store id.

  • starts_atstringdate-time

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

  • descriptionstringObligatorio

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

  • created_at_foreignstringdate-time

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

  • updated_at_foreignstringdate-time

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add segmentMAILCHIMP_ADD_SEGMENTAcción

Create a new segment in a specific list.

Parámetros de entrada

  • namestringObligatorio

    The name of the segment.

  • list_idstringObligatorio

    The unique ID for the list.

  • options__matchstringenum

    Match type.

    anyall
  • static_segmentstring[]

    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.

  • options__conditionsobject[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add storeMAILCHIMP_ADD_STOREAcción

Add a new store to your mailchimp account.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier for the store.

  • namestringObligatorio

    The name of the store.

  • phonestring

    The store phone number.

  • domainstring

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

  • list_idstringObligatorio

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

  • platformstring

    The e-commerce platform of the store.

  • timezonestring

    The timezone for the store.

  • is_syncingboolean

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

  • money_formatstring

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

  • address__citystring

    The city the store is located in.

  • currency_codestringObligatorio

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

  • email_addressstring

    The email address for the store.

  • primary_localestring

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

  • address__countrystring

    The store"s country.

  • address__address1string

    The store"s mailing address.

  • address__address2string

    An additional field for the store"s mailing address.

  • address__latitudeinteger

    The latitude of the store location.

  • address__provincestring

    The store"s state name or normalized province.

  • address__longitudeinteger

    The longitude of the store location.

  • address__postal__codestring

    The store"s postal or zip code.

  • address__country__codestring

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

  • address__province__codestring

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add subscriber to workflow emailMAILCHIMP_ADD_SUBSCRIBER_TO_WORKFLOW_EMAILAcción

Manually add a subscriber to a workflow, bypassing the default trigger settings. you can also use this endpoint to trigger a series of automated emails in an api 3.0 workflow type.

Parámetros de entrada

  • workflow_idstringObligatorio

    The unique id for the Automation workflow.

  • email_addressstringObligatorio

    The list member"s email address.

  • workflow_email_idstringObligatorio

    The unique id for the Automation workflow email.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add templateMAILCHIMP_ADD_TEMPLATEAcción

Create a new template for the account. only classic templates are supported.

Parámetros de entrada

  • htmlstringObligatorio

    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.

  • namestringObligatorio

    The name of the template.

  • folder_idstring

    The id of the folder the template is currently in.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add template folderMAILCHIMP_ADD_TEMPLATE_FOLDERAcción

Create a new template folder.

Parámetros de entrada

  • namestringObligatorio

    The name of the folder.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add webhookMAILCHIMP_ADD_WEBHOOKAcción

Create a new webhook for a specific list.

Parámetros de entrada

  • urlstring

    A valid URL for the Webhook.

  • list_idstringObligatorio

    The unique ID for the list.

  • sources__apiboolean

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

  • sources__userboolean

    Whether the webhook is triggered by subscriber-initiated actions.

  • sources__adminboolean

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

  • events__cleanedboolean

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

  • events__profileboolean

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

  • events__upemailboolean

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

  • events__campaignboolean

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

  • events__subscribeboolean

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

  • events__unsubscribeboolean

    Whether the webhook is triggered when a list member unsubscribes.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Archive automationMAILCHIMP_ARCHIVE_AUTOMATIONAcción

Archiving will permanently end your automation and keep the report data. you’ll be able to replicate your archived automation, but you can’t restart it.

Parámetros de entrada

  • workflow_idstringObligatorio

    The unique id for the Automation workflow.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Archive list memberMAILCHIMP_ARCHIVE_LIST_MEMBERAcción

Archive a list member. to permanently delete, use the delete-permanent action.

Parámetros de entrada

  • list_idstringObligatorio

    The unique ID for the list.

  • subscriber_hashstringObligatorio

    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.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Batch add or remove membersMAILCHIMP_BATCH_ADD_OR_REMOVE_MEMBERSAcción

Batch add/remove list members to static segment

Parámetros de entrada

  • list_idstringObligatorio

    The unique ID for the list.

  • segment_idstringObligatorio

    The unique id for the segment.

  • members_to_addstring[]

    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.

  • members_to_removestring[]

    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.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Batch subscribe or unsubscribeMAILCHIMP_BATCH_SUBSCRIBE_OR_UNSUBSCRIBEAcción

Batch subscribe or unsubscribe list members.

Parámetros de entrada

  • list_idstringObligatorio

    The unique ID for the list.

  • membersobject[]Obligatorio

    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.

  • sync_tagsboolean

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

  • update_existingboolean

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

  • skip_duplicate_checkboolean

    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.

  • skip_merge_validationboolean

    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.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Campaign abuse report detailsMAILCHIMP_CAMPAIGN_ABUSE_REPORT_DETAILSAcción

Get information about a specific abuse report for a campaign.

Parámetros de entrada

  • fieldsstring[]

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

  • report_idstringObligatorio

    The id for the abuse report.

  • campaign_idstringObligatorio

    The unique id for the campaign.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Campaign statistics feedbackMAILCHIMP_CAMPAIGN_STATISTICS_FEEDBACKAcción

Get feedback based on a campaign's statistics. advice feedback is based on campaign stats like opens, clicks, unsubscribes, bounces, and more.

Parámetros de entrada

  • fieldsstring[]

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

  • campaign_idstringObligatorio

    The unique id for the campaign.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Cancel campaignMAILCHIMP_CANCEL_CAMPAIGNAcción

Cancel a regular or plain-text campaign after you send, before all of your recipients receive it. this feature is included with mailchimp pro.

Parámetros de entrada

  • campaign_idstringObligatorio

    The unique id for the campaign.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create a survey campaignMAILCHIMP_CREATE_A_SURVEY_CAMPAIGNAcción

Utilize the list id and survey id to generate a campaign that links to your survey.

Parámetros de entrada

  • list_idstringObligatorio

    The unique ID for the list.

  • survey_idstringObligatorio

    The ID of the survey.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Customer journeys api trigger for a contactMAILCHIMP_CUSTOMER_JOURNEYS_API_TRIGGER_FOR_A_CONTACTAcción

Create a trigger step in the customer journey builder via the api. use the provided url with {journey id} and {step id} to activate conditions for a contact.

Parámetros de entrada

  • step_idintegerObligatorio

    The id for the Step.

  • journey_idintegerObligatorio

    The id for the Journey.

  • email_addressstringObligatorio

    The list member"s email address.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Customize signup formMAILCHIMP_CUSTOMIZE_SIGNUP_FORMAcción

Customize a list's default signup form.

Parámetros de entrada

  • stylesobject[]

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

  • list_idstringObligatorio

    The unique ID for the list.

  • contentsobject[]

    The signup form body content.

  • header__textstring

    Header text.

  • header__image__altstring

    Alt text for the image.

  • header__image__urlstring

    Header image URL.

  • header__image__linkstring

    The URL that the header image will link to.

  • header__image__alignstringenum

    Image alignment.

    noneleftcenterright
  • header__image__widthstring

    Image width, in pixels.

  • header__image__heightstring

    Image height, in pixels.

  • header__image__targetstringenum

    Image link target.

    _blanknull
  • header__image__border__colorstring

    Image border color.

  • header__image__border__stylestringenum

    Image border style.

    nonesoliddotteddasheddoublegrooveoutsetinsetridge
  • header__image__border__widthstring

    Image border width.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete batch requestMAILCHIMP_DELETE_BATCH_REQUESTAcción

Stops a batch request from running. since only one batch request is run at a time, this can be used to cancel a long running request. the results of any completed operations will not be available after this call.

Parámetros de entrada

  • batch_idstringObligatorio

    The unique id for the batch operation.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete batch webhookMAILCHIMP_DELETE_BATCH_WEBHOOKAcción

Remove a batch webhook. webhooks will no longer be sent to the given url.

Parámetros de entrada

  • batch_webhook_idstringObligatorio

    The unique id for the batch webhook.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete campaignMAILCHIMP_DELETE_CAMPAIGNAcción

Remove a campaign from your mailchimp account.

Parámetros de entrada

  • campaign_idstringObligatorio

    The unique id for the campaign.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete campaign feedback messageMAILCHIMP_DELETE_CAMPAIGN_FEEDBACK_MESSAGEAcción

Remove a specific feedback message for a campaign.

Parámetros de entrada

  • campaign_idstringObligatorio

    The unique id for the campaign.

  • feedback_idstringObligatorio

    The unique id for the feedback message.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete campaign folderMAILCHIMP_DELETE_CAMPAIGN_FOLDERAcción

Delete a specific campaign folder, and mark all the campaigns in the folder as 'unfiled'.

Parámetros de entrada

  • folder_idstringObligatorio

    The unique id for the campaign folder.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete cartMAILCHIMP_DELETE_CARTAcción

Delete a cart.

Parámetros de entrada

  • cart_idstringObligatorio

    The id for the cart.

  • store_idstringObligatorio

    The store id.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete cart line itemMAILCHIMP_DELETE_CART_LINE_ITEMAcción

Delete a specific cart line item.

Parámetros de entrada

  • cart_idstringObligatorio

    The id for the cart.

  • line_idstringObligatorio

    The id for the line item of a cart.

  • store_idstringObligatorio

    The store id.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete connected siteMAILCHIMP_DELETE_CONNECTED_SITEAcción

Remove a connected site from your mailchimp account.

Parámetros de entrada

  • connected_site_idstringObligatorio

    The unique identifier for the site.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete customerMAILCHIMP_DELETE_CUSTOMERAcción

Delete a customer from a store.

Parámetros de entrada

  • store_idstringObligatorio

    The store id.

  • customer_idstringObligatorio

    The id for the customer of a store.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete domainMAILCHIMP_DELETE_DOMAINAcción

Delete a verified domain from the account.

Parámetros de entrada

  • domain_namestringObligatorio

    The domain name.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete fileMAILCHIMP_DELETE_FILEAcción

Remove a specific file from the file manager.

Parámetros de entrada

  • file_idstringObligatorio

    The unique id for the File Manager file.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete folderMAILCHIMP_DELETE_FOLDERAcción

Delete a specific folder in the file manager.

Parámetros de entrada

  • folder_idstringObligatorio

    The unique id for the File Manager folder.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete interest categoryMAILCHIMP_DELETE_INTEREST_CATEGORYAcción

Delete a specific interest category.

Parámetros de entrada

  • list_idstringObligatorio

    The unique ID for the list.

  • interest_category_idstringObligatorio

    The unique ID for the interest category.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete interest in categoryMAILCHIMP_DELETE_INTEREST_IN_CATEGORYAcción

Delete interests or group names in a specific category.

Parámetros de entrada

  • list_idstringObligatorio

    The unique ID for the list.

  • interest_idstringObligatorio

    The specific interest or "group name".

  • interest_category_idstringObligatorio

    The unique ID for the interest category.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete landing pageMAILCHIMP_DELETE_LANDING_PAGEAcción

Delete a landing page.

Parámetros de entrada

  • page_idstringObligatorio

    The unique id for the page.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete listMAILCHIMP_DELETE_LISTAcción

Delete a list from your mailchimp account. if you delete a list, you'll lose the list history—including subscriber activity, unsubscribes, complaints, and bounces. you’ll also lose subscribers’ email addresses, unless you exported and backed up your list.

Parámetros de entrada

  • list_idstringObligatorio

    The unique ID for the list.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete list memberMAILCHIMP_DELETE_LIST_MEMBERAcción

Delete all personally identifiable information related to a list member, and remove them from a list. this will make it impossible to re-import the list member.

Parámetros de entrada

  • list_idstringObligatorio

    The unique ID for the list.

  • subscriber_hashstringObligatorio

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete merge fieldMAILCHIMP_DELETE_MERGE_FIELDAcción

Delete a specific merge field.

Parámetros de entrada

  • list_idstringObligatorio

    The unique ID for the list.

  • merge_idstringObligatorio

    The id for the merge field.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete noteMAILCHIMP_DELETE_NOTEAcción

Delete a specific note for a specific list member.

Parámetros de entrada

  • list_idstringObligatorio

    The unique ID for the list.

  • note_idstringObligatorio

    The id for the note.

  • subscriber_hashstringObligatorio

    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.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete orderMAILCHIMP_DELETE_ORDERAcción

Delete an order.

Parámetros de entrada

  • order_idstringObligatorio

    The id for the order in a store.

  • store_idstringObligatorio

    The store id.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete order line itemMAILCHIMP_DELETE_ORDER_LINE_ITEMAcción

Delete a specific order line item.

Parámetros de entrada

  • line_idstringObligatorio

    The id for the line item of an order.

  • order_idstringObligatorio

    The id for the order in a store.

  • store_idstringObligatorio

    The store id.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete productMAILCHIMP_DELETE_PRODUCTAcción

Delete a product.

Parámetros de entrada

  • store_idstringObligatorio

    The store id.

  • product_idstringObligatorio

    The id for the product of a store.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete product imageMAILCHIMP_DELETE_PRODUCT_IMAGEAcción

Delete a product image.

Parámetros de entrada

  • image_idstringObligatorio

    The id for the product image.

  • store_idstringObligatorio

    The store id.

  • product_idstringObligatorio

    The id for the product of a store.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete product variantMAILCHIMP_DELETE_PRODUCT_VARIANTAcción

Delete a product variant.

Parámetros de entrada

  • store_idstringObligatorio

    The store id.

  • product_idstringObligatorio

    The id for the product of a store.

  • variant_idstringObligatorio

    The id for the product variant.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete promo codeMAILCHIMP_DELETE_PROMO_CODEAcción

Delete a promo code from a store.

Parámetros de entrada

  • store_idstringObligatorio

    The store id.

  • promo_code_idstringObligatorio

    The id for the promo code of a store.

  • promo_rule_idstringObligatorio

    The id for the promo rule of a store.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete promo ruleMAILCHIMP_DELETE_PROMO_RULEAcción

Delete a promo rule from a store.

Parámetros de entrada

  • store_idstringObligatorio

    The store id.

  • promo_rule_idstringObligatorio

    The id for the promo rule of a store.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete segmentMAILCHIMP_DELETE_SEGMENTAcción

Delete a specific segment in a list.

Parámetros de entrada

  • list_idstringObligatorio

    The unique ID for the list.

  • segment_idstringObligatorio

    The unique id for the segment.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete storeMAILCHIMP_DELETE_STOREAcción

Delete a store. deleting a store will also delete any associated subresources, including customers, orders, products, and carts.

Parámetros de entrada

  • store_idstringObligatorio

    The store id.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete templateMAILCHIMP_DELETE_TEMPLATEAcción

Delete a specific template.

Parámetros de entrada

  • template_idstringObligatorio

    The unique id for the template.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete template folderMAILCHIMP_DELETE_TEMPLATE_FOLDERAcción

Delete a specific template folder, and mark all the templates in the folder as 'unfiled'.

Parámetros de entrada

  • folder_idstringObligatorio

    The unique id for the template folder.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete webhookMAILCHIMP_DELETE_WEBHOOKAcción

Delete a specific webhook in a list.

Parámetros de entrada

  • list_idstringObligatorio

    The unique ID for the list.

  • webhook_idstringObligatorio

    The webhook"s id.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete workflow emailMAILCHIMP_DELETE_WORKFLOW_EMAILAcción

Removes an individual classic automation workflow email. emails from certain workflow types, including the abandoned cart email (abandonedcart) and product retargeting email (abandonedbrowse) workflows, cannot be deleted.

Parámetros de entrada

  • workflow_idstringObligatorio

    The unique id for the Automation workflow.

  • workflow_email_idstringObligatorio

    The unique id for the Automation workflow email.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get abuse reportMAILCHIMP_GET_ABUSE_REPORTAcción

Get details about a specific abuse report.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • list_idstringObligatorio

    The unique ID for the list.

  • report_idstringObligatorio

    The id for the abuse report.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get account export infoMAILCHIMP_GET_ACCOUNT_EXPORT_INFOAcción

Get information about a specific account export.

Parámetros de entrada

  • fieldsstring[]

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

  • export_idstringObligatorio

    The unique id for the account export.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get authorized app infoMAILCHIMP_GET_AUTHORIZED_APP_INFOAcción

Get information about a specific authorized application.

Parámetros de entrada

  • app_idstringObligatorio

    The unique id for the connected authorized application.

  • fieldsstring[]

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

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get automated email subscriberMAILCHIMP_GET_AUTOMATED_EMAIL_SUBSCRIBERAcción

Get information about a specific subscriber in a classic automation email queue.

Parámetros de entrada

  • workflow_idstringObligatorio

    The unique id for the Automation workflow.

  • subscriber_hashstringObligatorio

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

  • workflow_email_idstringObligatorio

    The unique id for the Automation workflow email.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get automation infoMAILCHIMP_GET_AUTOMATION_INFOAcción

Get a summary of an individual classic automation workflow's settings and content. the `trigger settings` object returns information for the first email in the workflow.

Parámetros de entrada

  • fieldsstring[]

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

  • workflow_idstringObligatorio

    The unique id for the Automation workflow.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get batch operation statusMAILCHIMP_GET_BATCH_OPERATION_STATUSAcción

Get the status of a batch request.

Parámetros de entrada

  • fieldsstring[]

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

  • batch_idstringObligatorio

    The unique id for the batch operation.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get batch webhook infoMAILCHIMP_GET_BATCH_WEBHOOK_INFOAcción

Get information about a specific batch webhook.

Parámetros de entrada

  • fieldsstring[]

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

  • exclude_fieldsstring[]

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

  • batch_webhook_idstringObligatorio

    The unique id for the batch webhook.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get campaign contentMAILCHIMP_GET_CAMPAIGN_CONTENTAcción

Get the the html and plain-text content for a campaign.

Parámetros de entrada

  • fieldsstring[]

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

  • campaign_idstringObligatorio

    The unique id for the campaign.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get campaign feedback messageMAILCHIMP_GET_CAMPAIGN_FEEDBACK_MESSAGEAcción

Get a specific feedback message from a campaign.

Parámetros de entrada

  • fieldsstring[]

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

  • campaign_idstringObligatorio

    The unique id for the campaign.

  • feedback_idstringObligatorio

    The unique id for the feedback message.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get campaign folderMAILCHIMP_GET_CAMPAIGN_FOLDERAcción

Get information about a specific folder used to organize campaigns.

Parámetros de entrada

  • fieldsstring[]

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

  • folder_idstringObligatorio

    The unique id for the campaign folder.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get campaign infoMAILCHIMP_GET_CAMPAIGN_INFOAcción

Get information about a specific campaign.

Parámetros de entrada

  • fieldsstring[]

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

  • campaign_idstringObligatorio

    The unique id for the campaign.

  • exclude_fieldsstring[]

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

  • include_resend_shortcut_eligibilityboolean

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get campaign link detailsMAILCHIMP_GET_CAMPAIGN_LINK_DETAILSAcción

Get click details for a specific link in a campaign.

Parámetros de entrada

  • fieldsstring[]

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

  • link_idstringObligatorio

    The id for the link.

  • campaign_idstringObligatorio

    The unique id for the campaign.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get campaign recipient infoMAILCHIMP_GET_CAMPAIGN_RECIPIENT_INFOAcción

Get information about a specific campaign recipient.

Parámetros de entrada

  • fieldsstring[]

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

  • campaign_idstringObligatorio

    The unique id for the campaign.

  • exclude_fieldsstring[]

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

  • subscriber_hashstringObligatorio

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get campaign reportMAILCHIMP_GET_CAMPAIGN_REPORTAcción

Get report details for a specific sent campaign.

Parámetros de entrada

  • fieldsstring[]

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

  • campaign_idstringObligatorio

    The unique id for the campaign.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get campaign send checklistMAILCHIMP_GET_CAMPAIGN_SEND_CHECKLISTAcción

Review the send checklist for a campaign, and resolve any issues before sending.

Parámetros de entrada

  • fieldsstring[]

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

  • campaign_idstringObligatorio

    The unique id for the campaign.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get cart infoMAILCHIMP_GET_CART_INFOAcción

Get information about a specific cart.

Parámetros de entrada

  • fieldsstring[]

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

  • cart_idstringObligatorio

    The id for the cart.

  • store_idstringObligatorio

    The store id.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get cart line itemMAILCHIMP_GET_CART_LINE_ITEMAcción

Get information about a specific cart line item.

Parámetros de entrada

  • fieldsstring[]

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

  • cart_idstringObligatorio

    The id for the cart.

  • line_idstringObligatorio

    The id for the line item of a cart.

  • store_idstringObligatorio

    The store id.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get clicked link subscriberMAILCHIMP_GET_CLICKED_LINK_SUBSCRIBERAcción

Get information about a specific subscriber who clicked a link in a specific campaign.

Parámetros de entrada

  • fieldsstring[]

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

  • link_idstringObligatorio

    The id for the link.

  • campaign_idstringObligatorio

    The unique id for the campaign.

  • exclude_fieldsstring[]

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

  • subscriber_hashstringObligatorio

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get connected siteMAILCHIMP_GET_CONNECTED_SITEAcción

Get information about a specific connected site.

Parámetros de entrada

  • fieldsstring[]

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

  • exclude_fieldsstring[]

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

  • connected_site_idstringObligatorio

    The unique identifier for the site.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get conversationMAILCHIMP_GET_CONVERSATIONAcción

Api endpoint for conversations is deprecated, replaced by inbox. although historical data is accessible, new campaign replies and messages are not retrievable through this endpoint.

Parámetros de entrada

  • fieldsstring[]

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

  • exclude_fieldsstring[]

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

  • conversation_idstringObligatorio

    The unique id for the conversation.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get customer infoMAILCHIMP_GET_CUSTOMER_INFOAcción

Get information about a specific customer.

Parámetros de entrada

  • fieldsstring[]

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

  • store_idstringObligatorio

    The store id.

  • customer_idstringObligatorio

    The id for the customer of a store.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get domain infoMAILCHIMP_GET_DOMAIN_INFOAcción

Get the details for a single domain on the account.

Parámetros de entrada

  • domain_namestringObligatorio

    The domain name.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get facebook ad infoMAILCHIMP_GET_FACEBOOK_AD_INFOAcción

Get details of a facebook ad.

Parámetros de entrada

  • fieldsstring[]

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

  • outreach_idstringObligatorio

    The outreach id.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get facebook ad reportMAILCHIMP_GET_FACEBOOK_AD_REPORTAcción

Get report of a facebook ad.

Parámetros de entrada

  • fieldsstring[]

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

  • outreach_idstringObligatorio

    The outreach id.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get fileMAILCHIMP_GET_FILEAcción

Get information about a specific file in the file manager.

Parámetros de entrada

  • fieldsstring[]

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

  • file_idstringObligatorio

    The unique id for the File Manager file.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get folderMAILCHIMP_GET_FOLDERAcción

Get information about a specific folder in the file manager.

Parámetros de entrada

  • fieldsstring[]

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

  • folder_idstringObligatorio

    The unique id for the File Manager folder.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get growth history by monthMAILCHIMP_GET_GROWTH_HISTORY_BY_MONTHAcción

Get a summary of a specific list's growth activity for a specific month and year.

Parámetros de entrada

  • monthstringObligatorio

    A specific month of list growth history.

  • fieldsstring[]

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

  • list_idstringObligatorio

    The unique ID for the list.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get information about all surveys for a listMAILCHIMP_GET_INFORMATION_ABOUT_ALL_SURVEYS_FOR_A_LISTAcción

Get information about all available surveys for a specific list.

Parámetros de entrada

  • list_idstringObligatorio

    The unique ID for the list.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get interest category infoMAILCHIMP_GET_INTEREST_CATEGORY_INFOAcción

Get information about a specific interest category.

Parámetros de entrada

  • fieldsstring[]

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

  • list_idstringObligatorio

    The unique ID for the list.

  • exclude_fieldsstring[]

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

  • interest_category_idstringObligatorio

    The unique ID for the interest category.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get interest in categoryMAILCHIMP_GET_INTEREST_IN_CATEGORYAcción

Get interests or 'group names' for a specific category.

Parámetros de entrada

  • fieldsstring[]

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

  • list_idstringObligatorio

    The unique ID for the list.

  • interest_idstringObligatorio

    The specific interest or "group name".

  • exclude_fieldsstring[]

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

  • interest_category_idstringObligatorio

    The unique ID for the interest category.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get landing page contentMAILCHIMP_GET_LANDING_PAGE_CONTENTAcción

Get the the html for your landing page.

Parámetros de entrada

  • fieldsstring[]

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

  • page_idstringObligatorio

    The unique id for the page.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get landing page infoMAILCHIMP_GET_LANDING_PAGE_INFOAcción

Get information about a specific page.

Parámetros de entrada

  • fieldsstring[]

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

  • page_idstringObligatorio

    The unique id for the page.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get landing page reportMAILCHIMP_GET_LANDING_PAGE_REPORTAcción

Get report of a landing page.

Parámetros de entrada

  • fieldsstring[]

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

  • outreach_idstringObligatorio

    The outreach id.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get latest chimp chatterMAILCHIMP_GET_LATEST_CHIMP_CHATTERAcción

Return the chimp chatter for this account ordered by most recent.

Parámetros de entrada

  • countinteger

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

  • offsetinteger

    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.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get list infoMAILCHIMP_GET_LIST_INFOAcción

Get information about a specific list in your mailchimp account. results include list members who have signed up but haven't confirmed their subscription yet and unsubscribed or cleaned.

Parámetros de entrada

  • fieldsstring[]

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

  • list_idstringObligatorio

    The unique ID for the list.

  • exclude_fieldsstring[]

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

  • include_total_contactsboolean

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get lists infoMAILCHIMP_GET_LISTS_INFOAcción

Get information about all lists in the account.

Parámetros de entrada

  • countinteger

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

  • emailstring

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • sort_dirstringenum

    Determines the order direction for sorted results.

    ASCDESC
  • sort_fieldstringenum

    Returns files sorted by the specified field.

    date_created
  • exclude_fieldsstring[]

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

  • since_date_createdstring

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

  • before_date_createdstring

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

  • has_ecommerce_storeboolean

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

  • include_total_contactsboolean

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

  • since_campaign_last_sentstring

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

  • before_campaign_last_sentstring

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get member infoMAILCHIMP_GET_MEMBER_INFOAcción

Get information about a specific list member, including a currently subscribed, unsubscribed, or bounced member.

Parámetros de entrada

  • fieldsstring[]

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

  • list_idstringObligatorio

    The unique ID for the list.

  • exclude_fieldsstring[]

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

  • subscriber_hashstringObligatorio

    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.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get member noteMAILCHIMP_GET_MEMBER_NOTEAcción

Get a specific note for a specific list member.

Parámetros de entrada

  • fieldsstring[]

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

  • list_idstringObligatorio

    The unique ID for the list.

  • note_idstringObligatorio

    The id for the note.

  • exclude_fieldsstring[]

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

  • subscriber_hashstringObligatorio

    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.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get merge fieldMAILCHIMP_GET_MERGE_FIELDAcción

Get information about a specific merge field.

Parámetros de entrada

  • fieldsstring[]

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

  • list_idstringObligatorio

    The unique ID for the list.

  • merge_idstringObligatorio

    The id for the merge field.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get messageMAILCHIMP_GET_MESSAGEAcción

The conversation endpoint is outdated and replaced by inbox, which isn't supported by it. historical conversation data is accessible, but new replies and inbox messages are not.

Parámetros de entrada

  • fieldsstring[]

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

  • message_idstringObligatorio

    The unique id for the conversation message.

  • exclude_fieldsstring[]

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

  • conversation_idstringObligatorio

    The unique id for the conversation.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get opened campaign subscriberMAILCHIMP_GET_OPENED_CAMPAIGN_SUBSCRIBERAcción

Get information about a specific subscriber who opened a campaign.

Parámetros de entrada

  • fieldsstring[]

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

  • campaign_idstringObligatorio

    The unique id for the campaign.

  • exclude_fieldsstring[]

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

  • subscriber_hashstringObligatorio

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get order infoMAILCHIMP_GET_ORDER_INFOAcción

Get information about a specific order.

Parámetros de entrada

  • fieldsstring[]

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

  • order_idstringObligatorio

    The id for the order in a store.

  • store_idstringObligatorio

    The store id.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get order line itemMAILCHIMP_GET_ORDER_LINE_ITEMAcción

Get information about a specific order line item.

Parámetros de entrada

  • fieldsstring[]

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

  • line_idstringObligatorio

    The id for the line item of an order.

  • order_idstringObligatorio

    The id for the order in a store.

  • store_idstringObligatorio

    The store id.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get product image infoMAILCHIMP_GET_PRODUCT_IMAGE_INFOAcción

Get information about a specific product image.

Parámetros de entrada

  • fieldsstring[]

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

  • image_idstringObligatorio

    The id for the product image.

  • store_idstringObligatorio

    The store id.

  • product_idstringObligatorio

    The id for the product of a store.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get product infoMAILCHIMP_GET_PRODUCT_INFOAcción

Get information about a specific product.

Parámetros de entrada

  • fieldsstring[]

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

  • store_idstringObligatorio

    The store id.

  • product_idstringObligatorio

    The id for the product of a store.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get product variant infoMAILCHIMP_GET_PRODUCT_VARIANT_INFOAcción

Get information about a specific product variant.

Parámetros de entrada

  • fieldsstring[]

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

  • store_idstringObligatorio

    The store id.

  • product_idstringObligatorio

    The id for the product of a store.

  • variant_idstringObligatorio

    The id for the product variant.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get promo codeMAILCHIMP_GET_PROMO_CODEAcción

Get information about a specific promo code.

Parámetros de entrada

  • fieldsstring[]

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

  • store_idstringObligatorio

    The store id.

  • promo_code_idstringObligatorio

    The id for the promo code of a store.

  • promo_rule_idstringObligatorio

    The id for the promo rule of a store.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get promo ruleMAILCHIMP_GET_PROMO_RULEAcción

Get information about a specific promo rule.

Parámetros de entrada

  • fieldsstring[]

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

  • store_idstringObligatorio

    The store id.

  • promo_rule_idstringObligatorio

    The id for the promo rule of a store.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get segment infoMAILCHIMP_GET_SEGMENT_INFOAcción

Get information about a specific segment.

Parámetros de entrada

  • fieldsstring[]

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

  • list_idstringObligatorio

    The unique ID for the list.

  • segment_idstringObligatorio

    The unique id for the segment.

  • exclude_fieldsstring[]

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

  • include_cleanedboolean

    Include cleaned members in response

  • include_unsubscribedboolean

    Include unsubscribed members in response

  • include_transactionalboolean

    Include transactional members in response

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get store infoMAILCHIMP_GET_STORE_INFOAcción

Get information about a specific store.

Parámetros de entrada

  • fieldsstring[]

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

  • store_idstringObligatorio

    The store id.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get subscriber email activityMAILCHIMP_GET_SUBSCRIBER_EMAIL_ACTIVITYAcción

Get a specific list member's activity in a campaign including opens, clicks, and bounces.

Parámetros de entrada

  • sincestring

    Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

  • fieldsstring[]

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

  • campaign_idstringObligatorio

    The unique id for the campaign.

  • exclude_fieldsstring[]

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

  • subscriber_hashstringObligatorio

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get subscriber removed from workflowMAILCHIMP_GET_SUBSCRIBER_REMOVED_FROM_WORKFLOWAcción

Get information about a specific subscriber who was removed from a classic automation workflow.

Parámetros de entrada

  • workflow_idstringObligatorio

    The unique id for the Automation workflow.

  • subscriber_hashstringObligatorio

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get surveyMAILCHIMP_GET_SURVEYAcción

Get details about a specific survey.

Parámetros de entrada

  • list_idstringObligatorio

    The unique ID for the list.

  • survey_idstringObligatorio

    The ID of the survey.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get survey question reportMAILCHIMP_GET_SURVEY_QUESTION_REPORTAcción

Get report for a survey question.

Parámetros de entrada

  • fieldsstring[]

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

  • survey_idstringObligatorio

    The ID of the survey.

  • question_idstringObligatorio

    The ID of the survey question.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get survey reportMAILCHIMP_GET_SURVEY_REPORTAcción

Get report for a survey.

Parámetros de entrada

  • fieldsstring[]

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

  • survey_idstringObligatorio

    The ID of the survey.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get survey responseMAILCHIMP_GET_SURVEY_RESPONSEAcción

Get a single survey response.

Parámetros de entrada

  • survey_idstringObligatorio

    The ID of the survey.

  • response_idstringObligatorio

    The ID of the survey response.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get template folderMAILCHIMP_GET_TEMPLATE_FOLDERAcción

Get information about a specific folder used to organize templates.

Parámetros de entrada

  • fieldsstring[]

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

  • folder_idstringObligatorio

    The unique id for the template folder.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get template infoMAILCHIMP_GET_TEMPLATE_INFOAcción

Get information about a specific template.

Parámetros de entrada

  • fieldsstring[]

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

  • template_idstringObligatorio

    The unique id for the template.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get unsubscribed memberMAILCHIMP_GET_UNSUBSCRIBED_MEMBERAcción

Get information about a specific list member who unsubscribed from a campaign.

Parámetros de entrada

  • fieldsstring[]

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

  • campaign_idstringObligatorio

    The unique id for the campaign.

  • exclude_fieldsstring[]

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

  • subscriber_hashstringObligatorio

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get webhook infoMAILCHIMP_GET_WEBHOOK_INFOAcción

Get information about a specific webhook.

Parámetros de entrada

  • list_idstringObligatorio

    The unique ID for the list.

  • webhook_idstringObligatorio

    The webhook"s id.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get workflow email infoMAILCHIMP_GET_WORKFLOW_EMAIL_INFOAcción

Get information about an individual classic automation workflow email.

Parámetros de entrada

  • workflow_idstringObligatorio

    The unique id for the Automation workflow.

  • workflow_email_idstringObligatorio

    The unique id for the Automation workflow email.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List abuse reportsMAILCHIMP_LIST_ABUSE_REPORTSAcción

Get all abuse reports for a specific list.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • list_idstringObligatorio

    The unique ID for the list.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List account exportsMAILCHIMP_LIST_ACCOUNT_EXPORTSAcción

Get a list of account exports for a given account.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List account ordersMAILCHIMP_LIST_ACCOUNT_ORDERSAcción

Get information about an account's orders.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • campaign_idstring

    Restrict results to orders with a specific `campaign_id` value.

  • customer_idstring

    Restrict results to orders made by a specific customer.

  • outreach_idstring

    Restrict results to orders with a specific `outreach_id` value.

  • has_outreachboolean

    Restrict results to orders that have an outreach attached. For example, an email campaign or Facebook ad.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List answers for questionMAILCHIMP_LIST_ANSWERS_FOR_QUESTIONAcción

Get answers for a survey question.

Parámetros de entrada

  • fieldsstring[]

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

  • survey_idstringObligatorio

    The ID of the survey.

  • question_idstringObligatorio

    The ID of the survey question.

  • exclude_fieldsstring[]

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

  • respondent_familiarity_isstringenum

    Filter survey responses by familiarity of the respondents.

    newknownunknown

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List api root resourcesMAILCHIMP_LIST_API_ROOT_RESOURCESAcción

Get links to all other resources available in the api.

Parámetros de entrada

  • fieldsstring[]

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

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List authorized appsMAILCHIMP_LIST_AUTHORIZED_APPSAcción

Get a list of an account's registered, connected applications.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List automated emailsMAILCHIMP_LIST_AUTOMATED_EMAILSAcción

Get a summary of the emails in a classic automation workflow.

Parámetros de entrada

  • workflow_idstringObligatorio

    The unique id for the Automation workflow.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List automated email subscribersMAILCHIMP_LIST_AUTOMATED_EMAIL_SUBSCRIBERSAcción

Get information about a classic automation email queue.

Parámetros de entrada

  • workflow_idstringObligatorio

    The unique id for the Automation workflow.

  • workflow_email_idstringObligatorio

    The unique id for the Automation workflow email.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List automationsMAILCHIMP_LIST_AUTOMATIONSAcción

Get a summary of an account's classic automations.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • statusstringenum

    Restrict the results to automations with the specified status.

    savepausedsending
  • exclude_fieldsstring[]

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

  • since_start_timestring

    Restrict the response to automations started after this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00.

  • before_start_timestring

    Restrict the response to automations started before this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00.

  • since_create_timestring

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

  • before_create_timestring

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List batch requestsMAILCHIMP_LIST_BATCH_REQUESTSAcción

Get a summary of batch requests that have been made.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List batch webhooksMAILCHIMP_LIST_BATCH_WEBHOOKSAcción

Get all webhooks that have been configured for batches.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List campaign detailsMAILCHIMP_LIST_CAMPAIGN_DETAILSAcción

Get information about clicks on specific links in your mailchimp campaigns.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • sort_dirstringenum

    Determines the order direction for sorted results.

    ASCDESC
  • sort_fieldstringenum

    Returns click reports sorted by the specified field.

    total_clicksunique_clicks
  • campaign_idstringObligatorio

    The unique id for the campaign.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List campaign feedbackMAILCHIMP_LIST_CAMPAIGN_FEEDBACKAcción

Get team feedback while you're working together on a mailchimp campaign.

Parámetros de entrada

  • fieldsstring[]

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

  • campaign_idstringObligatorio

    The unique id for the campaign.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List campaign foldersMAILCHIMP_LIST_CAMPAIGN_FOLDERSAcción

Get all folders used to organize campaigns.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List campaign open detailsMAILCHIMP_LIST_CAMPAIGN_OPEN_DETAILSAcción

Get detailed information about any campaign emails that were opened by a list member.

Parámetros de entrada

  • countinteger

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

  • sincestring

    Restrict results to campaign open events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

  • fieldsstring[]

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

  • offsetinteger

    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.

  • sort_dirstringenum

    Determines the order direction for sorted results.

    ASCDESC
  • sort_fieldstringenum

    Returns open reports sorted by the specified field.

    opens_count
  • campaign_idstringObligatorio

    The unique id for the campaign.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List campaign product activityMAILCHIMP_LIST_CAMPAIGN_PRODUCT_ACTIVITYAcción

Get breakdown of product activity for a campaign

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • sort_fieldstringenum

    Returns files sorted by the specified field.

    titletotal_revenuetotal_purchased
  • campaign_idstringObligatorio

    The unique id for the campaign.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List campaign recipientsMAILCHIMP_LIST_CAMPAIGN_RECIPIENTSAcción

Get information about campaign recipients.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • campaign_idstringObligatorio

    The unique id for the campaign.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List campaign reportsMAILCHIMP_LIST_CAMPAIGN_REPORTSAcción

Get campaign reports.

Parámetros de entrada

  • typestringenum

    The campaign type.

    regularplaintextabsplitrssvariate
  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • exclude_fieldsstring[]

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

  • since_send_timestring

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

  • before_send_timestring

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List campaignsMAILCHIMP_LIST_CAMPAIGNSAcción

Get all campaigns in an account.

Parámetros de entrada

  • typestringenum

    The campaign type.

    regularplaintextabsplitrssvariate
  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • statusstringenum

    The status of the campaign.

    savepausedschedulesendingsent
  • list_idstring

    The unique id for the list.

  • sort_dirstringenum

    Determines the order direction for sorted results.

    ASCDESC
  • folder_idstring

    The unique folder id.

  • member_idstring

    Retrieve campaigns sent to a particular list member. Member ID is The MD5 hash of the lowercase version of the list member’s email address.

  • sort_fieldstringenum

    Returns files sorted by the specified field.

    create_timesend_time
  • exclude_fieldsstring[]

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

  • since_send_timestring

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

  • before_send_timestring

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

  • since_create_timestring

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

  • before_create_timestring

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

  • include_resend_shortcut_eligibilityboolean

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List cart line itemsMAILCHIMP_LIST_CART_LINE_ITEMSAcción

Get information about a cart's line items.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • cart_idstringObligatorio

    The id for the cart.

  • store_idstringObligatorio

    The store id.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List cartsMAILCHIMP_LIST_CARTSAcción

Get information about a store's carts.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • store_idstringObligatorio

    The store id.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List child campaign reportsMAILCHIMP_LIST_CHILD_CAMPAIGN_REPORTSAcción

Get a list of reports with child campaigns for a specific parent campaign.

Parámetros de entrada

  • fieldsstring[]

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

  • campaign_idstringObligatorio

    The unique id for the campaign.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List clicked link subscribersMAILCHIMP_LIST_CLICKED_LINK_SUBSCRIBERSAcción

Get information about list members who clicked on a specific link in a campaign.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • link_idstringObligatorio

    The id for the link.

  • campaign_idstringObligatorio

    The unique id for the campaign.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List connected sitesMAILCHIMP_LIST_CONNECTED_SITESAcción

Get all connected sites in an account.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List conversationsMAILCHIMP_LIST_CONVERSATIONSAcción

List of conversations for an account is available via an endpoint, but it's deprecated in favor of inbox. the endpoint excludes new inbox data including campaign replies and messages. past conversations remain accessible.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • list_idstring

    The unique id for the list.

  • campaign_idstring

    The unique id for the campaign.

  • exclude_fieldsstring[]

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

  • has_unread_messagesstringenum

    Whether the conversation has any unread messages.

    truefalse

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List customersMAILCHIMP_LIST_CUSTOMERSAcción

Get information about a store's customers.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • store_idstringObligatorio

    The store id.

  • email_addressstring

    Restrict the response to customers with the email address.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List domain performance statsMAILCHIMP_LIST_DOMAIN_PERFORMANCE_STATSAcción

Get statistics for the top-performing email domains in a campaign.

Parámetros de entrada

  • fieldsstring[]

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

  • campaign_idstringObligatorio

    The unique id for the campaign.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List eepurl activityMAILCHIMP_LIST_EEP_URL_ACTIVITYAcción

Get a summary of social activity for the campaign, tracked by eepurl.

Parámetros de entrada

  • fieldsstring[]

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

  • campaign_idstringObligatorio

    The unique id for the campaign.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List email activityMAILCHIMP_LIST_EMAIL_ACTIVITYAcción

Get a list of member's subscriber activity in a specific campaign.

Parámetros de entrada

  • countinteger

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

  • sincestring

    Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

  • fieldsstring[]

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

  • offsetinteger

    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.

  • campaign_idstringObligatorio

    The unique id for the campaign.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List facebook adsMAILCHIMP_LIST_FACEBOOK_ADSAcción

Get list of facebook ads.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • sort_dirstringenum

    Determines the order direction for sorted results.

    ASCDESC
  • sort_fieldstringenum

    Returns files sorted by the specified field.

    created_atupdated_atend_time
  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List facebook ads reportsMAILCHIMP_LIST_FACEBOOK_ADS_REPORTSAcción

Get reports of facebook ads.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • sort_dirstringenum

    Determines the order direction for sorted results.

    ASCDESC
  • sort_fieldstringenum

    Returns files sorted by the specified field.

    created_atupdated_atend_time
  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List facebook ecommerce reportMAILCHIMP_LIST_FACEBOOK_ECOMMERCE_REPORTAcción

Get breakdown of product activity for an outreach.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • sort_fieldstringenum

    Returns files sorted by the specified field.

    titletotal_revenuetotal_purchased
  • outreach_idstringObligatorio

    The outreach id.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List foldersMAILCHIMP_LIST_FOLDERSAcción

Get a list of all folders in the file manager.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • created_bystring

    The Mailchimp account user who created the File Manager file.

  • exclude_fieldsstring[]

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

  • since_created_atstring

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

  • before_created_atstring

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List growth history dataMAILCHIMP_LIST_GROWTH_HISTORY_DATAAcción

Get a month-by-month summary of a specific list's growth activity.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • list_idstringObligatorio

    The unique ID for the list.

  • sort_dirstringenum

    Determines the order direction for sorted results.

    ASCDESC
  • sort_fieldstringenum

    Returns files sorted by the specified field.

    month
  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List interest categoriesMAILCHIMP_LIST_INTEREST_CATEGORIESAcción

Get information about a list's interest categories.

Parámetros de entrada

  • typestring

    Restrict results a type of interest group

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • list_idstringObligatorio

    The unique ID for the list.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List interests in categoryMAILCHIMP_LIST_INTERESTS_IN_CATEGORYAcción

Get a list of this category's interests.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • list_idstringObligatorio

    The unique ID for the list.

  • exclude_fieldsstring[]

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

  • interest_category_idstringObligatorio

    The unique ID for the interest category.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List landing pagesMAILCHIMP_LIST_LANDING_PAGESAcción

Get all landing pages.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • sort_dirstringenum

    Determines the order direction for sorted results.

    ASCDESC
  • sort_fieldstringenum

    Returns files sorted by the specified field.

    created_atupdated_at
  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List landing pages reportsMAILCHIMP_LIST_LANDING_PAGES_REPORTSAcción

Get reports of landing pages.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List locationsMAILCHIMP_LIST_LOCATIONSAcción

Get the locations (countries) that the list's subscribers have been tagged to based on geocoding their ip address.

Parámetros de entrada

  • fieldsstring[]

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

  • list_idstringObligatorio

    The unique ID for the list.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List member eventsMAILCHIMP_LIST_MEMBER_EVENTSAcción

Get events for a contact.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • list_idstringObligatorio

    The unique ID for the list.

  • exclude_fieldsstring[]

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

  • subscriber_hashstringObligatorio

    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.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List member goal eventsMAILCHIMP_LIST_MEMBER_GOAL_EVENTSAcción

Get the last 50 goal events for a member on a specific list.

Parámetros de entrada

  • fieldsstring[]

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

  • list_idstringObligatorio

    The unique ID for the list.

  • exclude_fieldsstring[]

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

  • subscriber_hashstringObligatorio

    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.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List members infoMAILCHIMP_LIST_MEMBERS_INFOAcción

Get information about members in a specific mailchimp list.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • statusstringenum

    The subscriber"s status.

    subscribedunsubscribedcleanedpendingtransactionalarchived
  • list_idstringObligatorio

    The unique ID for the list.

  • sort_dirstringenum

    Determines the order direction for sorted results.

    ASCDESC
  • vip_onlyboolean

    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.

  • email_typestring

    The email type.

  • sort_fieldstringenum

    Returns files sorted by the specified field.

    timestamp_opttimestamp_signuplast_changed
  • interest_idsstring

    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 any supplied interest categories.

  • exclude_fieldsstring[]

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

  • interest_matchstringenum

    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.

    anyallnone
  • unique_email_idstring

    A unique identifier for the email address across all Mailchimp lists.

  • since_last_changedstring

    Restrict results to subscribers whose information changed after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

  • unsubscribed_sincestring

    Filter subscribers by those unsubscribed since a specific date. Using any status other than unsubscribed with this filter will result in an error.

  • before_last_changedstring

    Restrict results to subscribers whose information changed before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

  • since_last_campaignboolean

    Filter subscribers by those subscribed/unsubscribed/pending/cleaned since last email campaign send. Member status is required to use this filter.

  • since_timestamp_optstring

    Restrict results to subscribers who opted-in after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

  • before_timestamp_optstring

    Restrict results to subscribers who opted-in before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

  • interest_category_idstring

    The unique id for the interest category.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List members in segmentMAILCHIMP_LIST_MEMBERS_IN_SEGMENTAcción

Get information about members in a saved segment.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • list_idstringObligatorio

    The unique ID for the list.

  • segment_idstringObligatorio

    The unique id for the segment.

  • exclude_fieldsstring[]

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

  • include_cleanedboolean

    Include cleaned members in response

  • include_unsubscribedboolean

    Include unsubscribed members in response

  • include_transactionalboolean

    Include transactional members in response

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List member tagsMAILCHIMP_LIST_MEMBER_TAGSAcción

Get the tags on a list member.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • list_idstringObligatorio

    The unique ID for the list.

  • exclude_fieldsstring[]

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

  • subscriber_hashstringObligatorio

    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.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List merge fieldsMAILCHIMP_LIST_MERGE_FIELDSAcción

Get a list of all merge fields for an audience.

Parámetros de entrada

  • typestring

    The merge field type.

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • list_idstringObligatorio

    The unique ID for the list.

  • requiredboolean

    Whether it"s a required merge field.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List messagesMAILCHIMP_LIST_MESSAGESAcción

Legacy "conversations" endpoint is deprecated; use "inbox" for new messages. old conversations are accessible, but new campaign replies and inbox messages are not.

Parámetros de entrada

  • fieldsstring[]

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

  • is_readstringenum

    Whether a conversation message has been marked as read.

    truefalse
  • exclude_fieldsstring[]

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

  • conversation_idstringObligatorio

    The unique id for the conversation.

  • since_timestampstring

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

  • before_timestampstring

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List order line itemsMAILCHIMP_LIST_ORDER_LINE_ITEMSAcción

Get information about an order's line items.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • order_idstringObligatorio

    The id for the order in a store.

  • store_idstringObligatorio

    The store id.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List ordersMAILCHIMP_LIST_ORDERSAcción

Get information about a store's orders.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • store_idstringObligatorio

    The store id.

  • campaign_idstring

    Restrict results to orders with a specific `campaign_id` value.

  • customer_idstring

    Restrict results to orders made by a specific customer.

  • outreach_idstring

    Restrict results to orders with a specific `outreach_id` value.

  • has_outreachboolean

    Restrict results to orders that have an outreach attached. For example, an email campaign or Facebook ad.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List productMAILCHIMP_LIST_PRODUCTAcción

Get information about a store's products.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • store_idstringObligatorio

    The store id.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List product imagesMAILCHIMP_LIST_PRODUCT_IMAGESAcción

Get information about a product's images.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • store_idstringObligatorio

    The store id.

  • product_idstringObligatorio

    The id for the product of a store.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List product variantsMAILCHIMP_LIST_PRODUCT_VARIANTSAcción

Get information about a product's variants.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • store_idstringObligatorio

    The store id.

  • product_idstringObligatorio

    The id for the product of a store.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List promo codesMAILCHIMP_LIST_PROMO_CODESAcción

Get information about a store's promo codes.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • store_idstringObligatorio

    The store id.

  • promo_rule_idstringObligatorio

    The id for the promo rule of a store.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List promo rulesMAILCHIMP_LIST_PROMO_RULESAcción

Get information about a store's promo rules.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • store_idstringObligatorio

    The store id.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List recent activityMAILCHIMP_LIST_RECENT_ACTIVITYAcción

Get up to the previous 180 days of daily detailed aggregated activity stats for a list, not including automation activity.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • list_idstringObligatorio

    The unique ID for the list.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List recent member notesMAILCHIMP_LIST_RECENT_MEMBER_NOTESAcción

Get recent notes for a specific list member.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • list_idstringObligatorio

    The unique ID for the list.

  • sort_dirstringenum

    Determines the order direction for sorted results.

    ASCDESC
  • sort_fieldstringenum

    Returns notes sorted by the specified field.

    created_atupdated_atnote_id
  • exclude_fieldsstring[]

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

  • subscriber_hashstringObligatorio

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List segmentsMAILCHIMP_LIST_SEGMENTSAcción

Get information about all available segments for a specific list.

Parámetros de entrada

  • typestring

    Limit results based on segment type.

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • list_idstringObligatorio

    The unique ID for the list.

  • exclude_fieldsstring[]

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

  • include_cleanedboolean

    Include cleaned members in response

  • since_created_atstring

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

  • since_updated_atstring

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

  • before_created_atstring

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

  • before_updated_atstring

    Restrict results to segments update before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

  • include_unsubscribedboolean

    Include unsubscribed members in response

  • include_transactionalboolean

    Include transactional members in response

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List sending domainsMAILCHIMP_LIST_SENDING_DOMAINSAcción

Get all of the sending domains on the account.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List signup formsMAILCHIMP_LIST_SIGNUP_FORMSAcción

Get signup forms for a specific list.

Parámetros de entrada

  • list_idstringObligatorio

    The unique ID for the list.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List stored filesMAILCHIMP_LIST_STORED_FILESAcción

Get a list of available images and files stored in the file manager for the account.

Parámetros de entrada

  • typestring

    The file type for the File Manager file.

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • sort_dirstringenum

    Determines the order direction for sorted results.

    ASCDESC
  • created_bystring

    The Mailchimp account user who created the File Manager file.

  • sort_fieldstringenum

    Returns files sorted by the specified field.

    added_datenamesize
  • exclude_fieldsstring[]

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

  • since_created_atstring

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

  • before_created_atstring

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List storesMAILCHIMP_LIST_STORESAcción

Get information about all stores in the account.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List subscribers removed from workflowMAILCHIMP_LIST_SUBSCRIBERS_REMOVED_FROM_WORKFLOWAcción

Get information about subscribers who were removed from a classic automation workflow.

Parámetros de entrada

  • workflow_idstringObligatorio

    The unique id for the Automation workflow.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List survey question reportsMAILCHIMP_LIST_SURVEY_QUESTION_REPORTSAcción

Get reports for survey questions.

Parámetros de entrada

  • fieldsstring[]

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

  • survey_idstringObligatorio

    The ID of the survey.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List survey reportsMAILCHIMP_LIST_SURVEY_REPORTSAcción

Get reports for surveys.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List survey responsesMAILCHIMP_LIST_SURVEY_RESPONSESAcción

Get responses to a survey.

Parámetros de entrada

  • fieldsstring[]

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

  • survey_idstringObligatorio

    The ID of the survey.

  • chose_answerstring

    The ID of the option chosen to filter responses on.

  • exclude_fieldsstring[]

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

  • answered_questioninteger

    The ID of the question that was answered.

  • respondent_familiarity_isstringenum

    Filter survey responses by familiarity of the respondents.

    newknownunknown

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List template foldersMAILCHIMP_LIST_TEMPLATE_FOLDERSAcción

Get all folders used to organize templates.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List templatesMAILCHIMP_LIST_TEMPLATESAcción

Get a list of an account's available templates.

Parámetros de entrada

  • typestring

    Limit results based on template type.

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • categorystring

    Limit results based on category.

  • sort_dirstringenum

    Determines the order direction for sorted results.

    ASCDESC
  • folder_idstring

    The unique folder id.

  • created_bystring

    The Mailchimp account user who created the template.

  • sort_fieldstringenum

    Returns user templates sorted by the specified field.

    date_createddate_editedname
  • content_typestringenum

    Limit results based on how the template"s content is put together. Only templates of type `user` can be filtered by `content_type`. If you want to retrieve saved templates created with the legacy email editor, then filter `content_type` to `template`. If you"d rather pull your saved templates for the new editor, filter to `multichannel`. For code your own templates, filter to `html`.

    htmltemplatemultichannel
  • exclude_fieldsstring[]

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

  • since_date_createdstring

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

  • before_date_createdstring

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List top email clientsMAILCHIMP_LIST_TOP_EMAIL_CLIENTSAcción

Get a list of the top email clients based on user-agent strings.

Parámetros de entrada

  • fieldsstring[]

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

  • list_idstringObligatorio

    The unique ID for the list.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List top open activitiesMAILCHIMP_LIST_TOP_OPEN_ACTIVITIESAcción

Get top open locations for a specific campaign.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • campaign_idstringObligatorio

    The unique id for the campaign.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List unsubscribed membersMAILCHIMP_LIST_UNSUBSCRIBED_MEMBERSAcción

Get information about members who have unsubscribed from a specific campaign.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • campaign_idstringObligatorio

    The unique id for the campaign.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List webhooksMAILCHIMP_LIST_WEBHOOKSAcción

Get information about all webhooks for a specific list.

Parámetros de entrada

  • list_idstringObligatorio

    The unique ID for the list.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Pause automated emailMAILCHIMP_PAUSE_AUTOMATED_EMAILAcción

Pause an automated email.

Parámetros de entrada

  • workflow_idstringObligatorio

    The unique id for the Automation workflow.

  • workflow_email_idstringObligatorio

    The unique id for the Automation workflow email.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Pause automation emailsMAILCHIMP_PAUSE_AUTOMATION_EMAILSAcción

Pause all emails in a specific classic automation workflow.

Parámetros de entrada

  • workflow_idstringObligatorio

    The unique id for the Automation workflow.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Pause rss campaignMAILCHIMP_PAUSE_RSS_CAMPAIGNAcción

Pause an rss-driven campaign.

Parámetros de entrada

  • campaign_idstringObligatorio

    The unique id for the campaign.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

PingMAILCHIMP_PINGAcción

A health check for the api that won't return any account-specific information.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Publish a surveyMAILCHIMP_PUBLISH_A_SURVEYAcción

Publish a survey that is in draft, unpublished, or has been previously published and edited.

Parámetros de entrada

  • list_idstringObligatorio

    The unique ID for the list.

  • survey_idstringObligatorio

    The ID of the survey.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Publish landing pageMAILCHIMP_PUBLISH_LANDING_PAGEAcción

Publish a landing page that is in draft, unpublished, or has been previously published and edited.

Parámetros de entrada

  • page_idstringObligatorio

    The unique id for the page.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Remove list member from segmentMAILCHIMP_REMOVE_LIST_MEMBER_FROM_SEGMENTAcción

Remove a member from the specified static segment.

Parámetros de entrada

  • list_idstringObligatorio

    The unique ID for the list.

  • segment_idstringObligatorio

    The unique id for the segment.

  • subscriber_hashstringObligatorio

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Remove subscriber from workflowMAILCHIMP_REMOVE_SUBSCRIBER_FROM_WORKFLOWAcción

Remove a subscriber from any point in a classic automation workflow; once removed, they cannot be re-added to that workflow.

Parámetros de entrada

  • workflow_idstringObligatorio

    The unique id for the Automation workflow.

  • email_addressstringObligatorio

    The list member"s email address.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Replicate campaignMAILCHIMP_REPLICATE_CAMPAIGNAcción

Replicate a campaign in saved or send status.

Parámetros de entrada

  • campaign_idstringObligatorio

    The unique id for the campaign.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Resend campaignMAILCHIMP_RESEND_CAMPAIGNAcción

Remove the guesswork for resending a campaign to certain segments. you can use this endpoint as a shortcut to replicate a campaign and resend it to common segments, such as those who didn't open the campaign, or any new subscribers since it was sent.

Parámetros de entrada

  • campaign_idstringObligatorio

    The unique id for the campaign.

  • shortcut_typestringenum

    Which campaign resend shortcut to use. Default is `to_non_openers`.

    to_non_openersto_new_subscribersto_non_clickers

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Resume rss campaignMAILCHIMP_RESUME_RSS_CAMPAIGNAcción

Resume an rss-driven campaign.

Parámetros de entrada

  • campaign_idstringObligatorio

    The unique id for the campaign.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve campaign abuse complaintsMAILCHIMP_RETRIEVE_CAMPAIGN_ABUSE_COMPLAINTSAcción

Get a list of abuse complaints for a specific campaign.

Parámetros de entrada

  • fieldsstring[]

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

  • campaign_idstringObligatorio

    The unique id for the campaign.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve folder contentsMAILCHIMP_RETRIEVE_FOLDER_CONTENTSAcción

Get a list of available images and files stored in this folder.

Parámetros de entrada

  • typestring

    The file type for the File Manager file.

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • sort_dirstringenum

    Determines the order direction for sorted results.

    ASCDESC
  • folder_idstringObligatorio

    The unique id for the File Manager folder.

  • created_bystring

    The Mailchimp account user who created the File Manager file.

  • sort_fieldstringenum

    Returns files sorted by the specified field.

    added_datenamesize
  • exclude_fieldsstring[]

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

  • since_created_atstring

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

  • before_created_atstring

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Schedule campaignMAILCHIMP_SCHEDULE_CAMPAIGNAcción

Schedule a campaign for delivery. if you're using multivariate campaigns to test send times or sending rss campaigns, use the send action instead.

Parámetros de entrada

  • timewarpboolean

    Choose whether the campaign should use [Timewarp](https://mailchimp.com/help/use-timewarp/) when sending. Campaigns scheduled with Timewarp are localized based on the recipients" time zones. For example, a Timewarp campaign with a `schedule_time` of 13:00 will be sent to each recipient at 1:00pm in their local time. Cannot be set to `true` for campaigns using [Batch Delivery](https://mailchimp.com/help/schedule-batch-delivery/).

  • campaign_idstringObligatorio

    The unique id for the campaign.

  • schedule_timestringObligatoriodate-time

    The UTC date and time to schedule the campaign for delivery in ISO 8601 format. Campaigns may only be scheduled to send on the quarter-hour (:00, :15, :30, :45).

  • batch__delivery__batch__countinteger

    The number of batches for the campaign send.

  • batch__delivery__batch__delayinteger

    The delay, in minutes, between batches.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Search campaignsMAILCHIMP_SEARCH_CAMPAIGNSAcción

Search all campaigns for the specified query terms.

Parámetros de entrada

  • querystringObligatorio

    The search query used to filter results.

  • fieldsstring[]

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

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Search for tags on a list by nameMAILCHIMP_SEARCH_FOR_TAGS_ON_A_LIST_BY_NAMEAcción

Search for tags on a list by name. if no name is provided, will return all tags on the list.

Parámetros de entrada

  • namestring

    The search query used to filter tags. The search query will be compared to each tag as a prefix, so all tags that have a name starting with this field will be returned.

  • list_idstringObligatorio

    The unique ID for the list.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Search membersMAILCHIMP_SEARCH_MEMBERSAcción

Search for list members. this search can be restricted to a specific list, or can be used to search across all lists in an account.

Parámetros de entrada

  • querystringObligatorio

    The search query used to filter results. Query should be a valid email, or a string representing a contact"s first or last name.

  • fieldsstring[]

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

  • list_idstring

    The unique id for the list.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Send campaignMAILCHIMP_SEND_CAMPAIGNAcción

Send a mailchimp campaign. for rss campaigns, the campaign will send according to its schedule. all other campaigns will send immediately.

Parámetros de entrada

  • campaign_idstringObligatorio

    The unique id for the campaign.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Send test emailMAILCHIMP_SEND_TEST_EMAILAcción

Send a test email.

Parámetros de entrada

  • send_typestringObligatorioenum

    Choose the type of test email to send.

    htmlplaintext
  • campaign_idstringObligatorio

    The unique id for the campaign.

  • test_emailsstring[]Obligatorio

    An array of email addresses to send the test email to.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Set campaign contentMAILCHIMP_SET_CAMPAIGN_CONTENTAcción

Set the content for a campaign.

Parámetros de entrada

  • urlstring

    When importing a campaign, the URL where the HTML lives.

  • htmlstring

    The raw HTML for the campaign.

  • plain_textstring

    The plain-text portion of the campaign. If left unspecified, we"ll generate this automatically.

  • campaign_idstringObligatorio

    The unique id for the campaign.

  • template__idinteger

    The id of the template to use.

  • variate_contentsobject[]

    Content options for [Multivariate Campaigns](https://mailchimp.com/help/about-multivariate-campaigns/). Each content option must provide HTML content and may optionally provide plain text. For campaigns not testing content, only one object should be provided.

  • archive__archive__typestringenum

    The type of encoded file. Defaults to zip.

    ziptar.gztar.bz2tartgztbz
  • archive__archive__contentstring

    The base64-encoded representation of the archive file.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Start automated emailMAILCHIMP_START_AUTOMATED_EMAILAcción

Start an automated email.

Parámetros de entrada

  • workflow_idstringObligatorio

    The unique id for the Automation workflow.

  • workflow_email_idstringObligatorio

    The unique id for the Automation workflow email.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Start automation emailsMAILCHIMP_START_AUTOMATION_EMAILSAcción

Start all emails in a classic automation workflow.

Parámetros de entrada

  • workflow_idstringObligatorio

    The unique id for the Automation workflow.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Start batch operationMAILCHIMP_START_BATCH_OPERATIONAcción

Begin processing a batch operations request.

Parámetros de entrada

  • operationsobject[]Obligatorio

    An array of objects that describes operations to perform.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Unpublish a surveyMAILCHIMP_UNPUBLISH_A_SURVEYAcción

Unpublish a survey that has been published.

Parámetros de entrada

  • list_idstringObligatorio

    The unique ID for the list.

  • survey_idstringObligatorio

    The ID of the survey.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Unpublish landing pageMAILCHIMP_UNPUBLISH_LANDING_PAGEAcción

Unpublish a landing page that is in draft or has been published.

Parámetros de entrada

  • page_idstringObligatorio

    The unique id for the page.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Unschedule campaignMAILCHIMP_UNSCHEDULE_CAMPAIGNAcción

Unschedule a scheduled campaign that hasn't started sending.

Parámetros de entrada

  • campaign_idstringObligatorio

    The unique id for the campaign.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update batch webhookMAILCHIMP_UPDATE_BATCH_WEBHOOKAcción

Update a webhook that will fire whenever any batch request completes processing.

Parámetros de entrada

  • urlstring

    A valid URL for the Webhook.

  • enabledboolean

    Whether the webhook receives requests or not.

  • batch_webhook_idstringObligatorio

    The unique id for the batch webhook.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update campaign feedback messageMAILCHIMP_UPDATE_CAMPAIGN_FEEDBACK_MESSAGEAcción

Update a specific feedback message for a campaign.

Parámetros de entrada

  • messagestring

    The content of the feedback.

  • block_idinteger

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

  • campaign_idstringObligatorio

    The unique id for the campaign.

  • feedback_idstringObligatorio

    The unique id for the feedback message.

  • is_completeboolean

    The status of feedback.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update campaign folderMAILCHIMP_UPDATE_CAMPAIGN_FOLDERAcción

Update a specific folder used to organize campaigns.

Parámetros de entrada

  • namestringObligatorio

    Name to associate with the folder.

  • folder_idstringObligatorio

    The unique id for the campaign folder.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update campaign settingsMAILCHIMP_UPDATE_CAMPAIGN_SETTINGSAcción

Update some or all of the settings for a specific campaign.

Parámetros de entrada

  • campaign_idstringObligatorio

    The unique id for the campaign.

  • settings__titlestring

    The title of the campaign.

  • tracking__opensboolean

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

  • settings__to__namestring

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

  • tracking__ecomm360boolean

    Whether to enable e-commerce tracking.

  • settings__reply__tostring

    The reply-to email address for the campaign.

  • social__card__titlestring

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

  • tracking__clicktalestring

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

  • recipients__list__idstring

    The unique list id.

  • rss__opts__feed__urlstringuri

    The URL for the RSS feed.

  • rss__opts__frequencystringenum

    The frequency of the RSS Campaign.

    dailyweeklymonthly
  • settings__folder__idstring

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

  • settings__from__namestring

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

  • settings__auto__tweetboolean

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

  • settings__inline__cssboolean

    Automatically inline the CSS included with the campaign content.

  • settings__authenticateboolean

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

  • settings__auto__footerboolean

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

  • settings__fb__commentsboolean

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

  • settings__template__idinteger

    The id of the template to use.

  • tracking__html__clicksboolean

    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.

  • tracking__text__clicksboolean

    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.

  • settings__preview__textstring

    The preview text for the campaign.

  • settings__subject__linestring

    The subject line for the campaign.

  • settings__auto__fb__poststring[]

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

  • social__card__image__urlstring

    The url for the header image for the card.

  • tracking__capsule__notesboolean

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

  • tracking__goal__trackingboolean

    Deprecated

  • rss__opts__schedule__hourinteger

    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/).

  • social__card__descriptionstring

    A short summary of the campaign to display.

  • settings__use__conversationboolean

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

  • tracking__google__analyticsstring

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

  • tracking__salesforce__notesboolean

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

  • variate__settings__test__sizeinteger

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

  • variate__settings__wait__timeinteger

    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.

  • rss__opts__constrain__rss__imgboolean

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

  • tracking__salesforce__campaignboolean

    Create a campaign in a connected Salesforce account.

  • variate__settings__from__namesstring[]

    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.

  • variate__settings__send__timesstring[]

    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.

  • recipients__segment__opts__matchstringenum

    Segment match type.

    anyall
  • variate__settings__subject__linesstring[]

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

  • variate__settings__winner__criteriastringenum

    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.

    opensclicksmanualtotal_revenue
  • recipients__segment__opts__conditionsobject[]

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

  • rss__opts__schedule__weekly__send__daystringenum

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

    sundaymondaytuesdaywednesdaythursdayfridaysaturday
  • variate__settings__reply__to__addressesstring[]

    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.

  • rss__opts__schedule__daily__send__fridayboolean

    Sends the daily RSS Campaign on Fridays.

  • rss__opts__schedule__daily__send__mondayboolean

    Sends the daily RSS Campaign on Mondays.

  • rss__opts__schedule__daily__send__sundayboolean

    Sends the daily RSS Campaign on Sundays.

  • rss__opts__schedule__monthly__send__dateinteger

    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.

  • rss__opts__schedule__daily__send__tuesdayboolean

    Sends the daily RSS Campaign on Tuesdays.

  • rss__opts__schedule__daily__send__saturdayboolean

    Sends the daily RSS Campaign on Saturdays.

  • rss__opts__schedule__daily__send__thursdayboolean

    Sends the daily RSS Campaign on Thursdays.

  • rss__opts__schedule__daily__send__wednesdayboolean

    Sends the daily RSS Campaign on Wednesdays.

  • recipients__segment__opts__saved__segment__idinteger

    The id for an existing saved segment.

  • recipients__segment__opts__prebuilt__segment__idstring

    The prebuilt segment id, if a prebuilt segment has been designated for this campaign.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update cartMAILCHIMP_UPDATE_CARTAcción

Update a specific cart.

Parámetros de entrada

  • linesobject[]

    An array of the cart"s line items.

  • cart_idstringObligatorio

    The id for the cart.

  • store_idstringObligatorio

    The store id.

  • tax_totalinteger

    The total tax for the cart.

  • campaign_idstring

    A string that uniquely identifies the campaign associated with a cart.

  • order_totalinteger

    The order total for the cart.

  • checkout_urlstring

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

  • currency_codestring

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

  • customer__companystring

    The customer"s company.

  • customer__last__namestring

    The customer"s last name.

  • customer__first__namestring

    The customer"s first name.

  • customer__address__citystring

    The city the customer is located in.

  • customer__opt__in__statusboolean

    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).

  • customer__address__countrystring

    The customer"s country.

  • customer__address__address1string

    The mailing address of the customer.

  • customer__address__address2string

    An additional field for the customer"s mailing address.

  • customer__address__provincestring

    The customer"s state name or normalized province.

  • customer__address__postal__codestring

    The customer"s postal or zip code.

  • customer__address__country__codestring

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

  • customer__address__province__codestring

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update cart line itemMAILCHIMP_UPDATE_CART_LINE_ITEMAcción

Update a specific cart line item.

Parámetros de entrada

  • priceinteger

    The price of a cart line item.

  • cart_idstringObligatorio

    The id for the cart.

  • line_idstringObligatorio

    The id for the line item of a cart.

  • quantityinteger

    The quantity of a cart line item.

  • store_idstringObligatorio

    The store id.

  • product_idstring

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

  • product_variant_idstring

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update customerMAILCHIMP_UPDATE_CUSTOMERAcción

Update a customer.

Parámetros de entrada

  • companystring

    The customer"s company.

  • store_idstringObligatorio

    The store id.

  • last_namestring

    The customer"s last name.

  • first_namestring

    The customer"s first name.

  • customer_idstringObligatorio

    The id for the customer of a store.

  • address__citystring

    The city the customer is located in.

  • opt_in_statusboolean

    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).

  • address__countrystring

    The customer"s country.

  • address__address1string

    The mailing address of the customer.

  • address__address2string

    An additional field for the customer"s mailing address.

  • address__provincestring

    The customer"s state name or normalized province.

  • address__postal__codestring

    The customer"s postal or zip code.

  • address__country__codestring

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

  • address__province__codestring

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update fileMAILCHIMP_UPDATE_FILEAcción

Update a file in the file manager.

Parámetros de entrada

  • namestring

    The name of the file.

  • file_idstringObligatorio

    The unique id for the File Manager file.

  • folder_idinteger

    The id of the folder. Setting `folder_id` to `0` will remove a file from its current folder.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update folderMAILCHIMP_UPDATE_FOLDERAcción

Update a specific file manager folder.

Parámetros de entrada

  • namestringObligatorio

    The name of the folder.

  • folder_idstringObligatorio

    The unique id for the File Manager folder.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update interest categoryMAILCHIMP_UPDATE_INTEREST_CATEGORYAcción

Update a specific interest category.

Parámetros de entrada

  • typestringObligatorioenum

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

    checkboxesdropdownradiohidden
  • titlestringObligatorio

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

  • list_idstringObligatorio

    The unique ID for the list.

  • display_orderinteger

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

  • interest_category_idstringObligatorio

    The unique ID for the interest category.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update interest in categoryMAILCHIMP_UPDATE_INTEREST_IN_CATEGORYAcción

Update interests or 'group names' for a specific category.

Parámetros de entrada

  • namestringObligatorio

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

  • list_idstringObligatorio

    The unique ID for the list.

  • interest_idstringObligatorio

    The specific interest or "group name".

  • display_orderinteger

    The display order for interests.

  • interest_category_idstringObligatorio

    The unique ID for the interest category.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update landing pageMAILCHIMP_UPDATE_LANDING_PAGEAcción

Update a landing page.

Parámetros de entrada

  • namestring

    The name of this landing page.

  • titlestring

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

  • list_idstring

    The list"s ID associated with this landing page.

  • page_idstringObligatorio

    The unique id for the page.

  • store_idstring

    The ID of the store associated with this landing page.

  • descriptionstring

    The description of this landing page.

  • tracking__track__with__mailchimpboolean

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

  • tracking__enable__restricted__data__processingboolean

    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/).

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update list memberMAILCHIMP_UPDATE_LIST_MEMBERAcción

Update information for a specific list member.

Parámetros de entrada

  • vipboolean

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

  • ip_optstring

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

  • statusstringenum

    Subscriber"s current status.

    subscribedunsubscribedcleanedpending
  • list_idstringObligatorio

    The unique ID for the list.

  • languagestring

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

  • interestsobject

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

  • ip_signupstring

    IP address the subscriber signed up from.

  • email_typestring

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

  • merge_fieldsobject

    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_addressstring

    Email address for a subscriber.

  • timestamp_optstringdate-time

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

  • subscriber_hashstringObligatorio

    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.

  • timestamp_signupstringdate-time

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

  • location__latitudeinteger

    The location latitude.

  • location__longitudeinteger

    The location longitude.

  • marketing_permissionsobject[]

    The marketing permissions for the subscriber.

  • skip_merge_validationboolean

    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.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update listsMAILCHIMP_UPDATE_LISTSAcción

Update the settings for a specific list.

Parámetros de entrada

  • namestringObligatorio

    The name of the list.

  • list_idstringObligatorio

    The unique ID for the list.

  • contact__zipstring

    The postal or zip code for the list contact.

  • double_optinboolean

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

  • contact__citystring

    The city for the list contact.

  • contact__phonestring

    The phone number for the list contact.

  • contact__statestring

    The state for the list contact.

  • use_archive_barboolean

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

  • contact__companystring

    The company name for the list.

  • contact__countrystring

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

  • contact__address1string

    The street address for the list contact.

  • contact__address2string

    The street address for the list contact.

  • email_type_optionbooleanObligatorio

    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.

  • notify_on_subscribestring

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

  • permission_reminderstringObligatorio

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

  • marketing_permissionsboolean

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

  • notify_on_unsubscribestring

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

  • campaign__defaults__subjectstring

    The default subject line for campaigns sent to this list.

  • campaign__defaults__languagestring

    The default language for this lists"s forms.

  • campaign__defaults__from__namestring

    The default from name for campaigns sent to this list.

  • campaign__defaults__from__emailstring

    The default from email for campaigns sent to this list.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update merge fieldMAILCHIMP_UPDATE_MERGE_FIELDAcción

Update a specific merge field.

Parámetros de entrada

  • tagstring

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

  • namestringObligatorio

    The name of the merge field (audience field).

  • publicboolean

    Whether the merge field is displayed on the signup form.

  • list_idstringObligatorio

    The unique ID for the list.

  • merge_idstringObligatorio

    The id for the merge field.

  • requiredboolean

    Whether the merge field is required to import a contact.

  • help_textstring

    Extra text to help the subscriber fill out the form.

  • default_valuestring

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

  • display_orderinteger

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

  • options__choicesstring[]

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

  • options__date__formatstring

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

  • options__phone__formatstring

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

  • options__default__countryinteger

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update noteMAILCHIMP_UPDATE_NOTEAcción

Update a specific note for a specific list member.

Parámetros de entrada

  • notestring

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

  • list_idstringObligatorio

    The unique ID for the list.

  • note_idstringObligatorio

    The id for the note.

  • subscriber_hashstringObligatorio

    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.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update orderMAILCHIMP_UPDATE_ORDERAcción

Update a specific order.

Parámetros de entrada

  • linesobject[]

    An array of the order"s line items.

  • promosobject[]

    The promo codes applied on the order. Note: Patch will completely replace the value of promos with the new one provided.

  • order_idstringObligatorio

    The id for the order in a store.

  • store_idstringObligatorio

    The store id.

  • order_urlstring

    The URL for the order.

  • tax_totalinteger

    The tax total associated with an order.

  • campaign_idstring

    A string that uniquely identifies the campaign associated with an order.

  • order_totalinteger

    The order total associated with an order.

  • landing_sitestring

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

  • outreach__idstring

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

  • tracking_urlstring

    The tracking URL associated with the order.

  • currency_codestring

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

  • tracking_codestringenum

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

    prec
  • discount_totalinteger

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

  • shipping_totalinteger

    The shipping total for the order.

  • tracking_numberstring

    The tracking number associated with the order.

  • financial_statusstring

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

  • tracking_carrierstring

    The tracking carrier associated with the order.

  • customer__companystring

    The customer"s company.

  • fulfillment_statusstring

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

  • updated_at_foreignstringdate-time

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

  • cancelled_at_foreignstringdate-time

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

  • customer__last__namestring

    The customer"s last name.

  • processed_at_foreignstringdate-time

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

  • customer__first__namestring

    The customer"s first name.

  • billing__address__citystring

    The city in the billing address.

  • billing__address__namestring

    The name associated with an order"s billing address.

  • billing__address__phonestring

    The phone number for the billing address.

  • customer__address__citystring

    The city the customer is located in.

  • shipping__address__citystring

    The city in the order"s shipping address.

  • shipping__address__namestring

    The name associated with an order"s shipping address.

  • shipping__address__phonestring

    The phone number for the order"s shipping address

  • billing__address__companystring

    The company associated with the billing address.

  • billing__address__countrystring

    The country in the billing address.

  • customer__opt__in__statusboolean

    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).

  • billing__address__address1string

    The billing address for the order.

  • billing__address__address2string

    An additional field for the billing address.

  • billing__address__latitudeinteger

    The latitude for the billing address location.

  • billing__address__provincestring

    The state or normalized province in the billing address.

  • customer__address__countrystring

    The customer"s country.

  • shipping__address__companystring

    The company associated with an order"s shipping address.

  • shipping__address__countrystring

    The country in the order"s shipping address.

  • billing__address__longitudeinteger

    The longitude for the billing address location.

  • customer__address__address1string

    The mailing address of the customer.

  • customer__address__address2string

    An additional field for the customer"s mailing address.

  • customer__address__provincestring

    The customer"s state name or normalized province.

  • shipping__address__address1string

    The shipping address for the order.

  • shipping__address__address2string

    An additional field for the shipping address.

  • shipping__address__latitudeinteger

    The latitude for the shipping address location.

  • shipping__address__provincestring

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

  • shipping__address__longitudeinteger

    The longitude for the shipping address location.

  • billing__address__postal__codestring

    The postal or zip code in the billing address.

  • billing__address__country__codestring

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

  • customer__address__postal__codestring

    The customer"s postal or zip code.

  • shipping__address__postal__codestring

    The postal or zip code in the order"s shipping address.

  • billing__address__province__codestring

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

  • customer__address__country__codestring

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

  • shipping__address__country__codestring

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

  • customer__address__province__codestring

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

  • shipping__address__province__codestring

    The two-letter code for the province or state the order"s shipping address is located in.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update order line itemMAILCHIMP_UPDATE_ORDER_LINE_ITEMAcción

Update a specific order line item.

Parámetros de entrada

  • priceinteger

    The price of an order line item.

  • line_idstringObligatorio

    The id for the line item of an order.

  • discountinteger

    The total discount amount applied to this line item.

  • order_idstringObligatorio

    The id for the order in a store.

  • quantityinteger

    The quantity of an order line item.

  • store_idstringObligatorio

    The store id.

  • product_idstring

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

  • product_variant_idstring

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update productMAILCHIMP_UPDATE_PRODUCTAcción

Update a specific product.

Parámetros de entrada

  • urlstring

    The URL for a product.

  • typestring

    The type of product.

  • titlestring

    The title of a product.

  • handlestring

    The handle of a product.

  • imagesobject[]

    An array of the product"s images.

  • vendorstring

    The vendor for a product.

  • store_idstringObligatorio

    The store id.

  • variantsobject[]

    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.

  • image_urlstring

    The image URL for a product.

  • product_idstringObligatorio

    The id for the product of a store.

  • descriptionstring

    The description of a product.

  • published_at_foreignstringdate-time

    The date and time the product was published in ISO 8601 format.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update product imageMAILCHIMP_UPDATE_PRODUCT_IMAGEAcción

Update a product image.

Parámetros de entrada

  • idstring

    A unique identifier for the product image.

  • urlstring

    The URL for a product image.

  • image_idstringObligatorio

    The id for the product image.

  • store_idstringObligatorio

    The store id.

  • product_idstringObligatorio

    The id for the product of a store.

  • variant_idsstring[]

    The list of product variants using the image.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update product variantMAILCHIMP_UPDATE_PRODUCT_VARIANTAcción

Update a product variant.

Parámetros de entrada

  • skustring

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

  • urlstring

    The URL for a product variant.

  • priceinteger

    The price of a product variant.

  • titlestring

    The title of a product variant.

  • store_idstringObligatorio

    The store id.

  • image_urlstring

    The image URL for a product variant.

  • backordersstring

    The backorders of a product variant.

  • product_idstringObligatorio

    The id for the product of a store.

  • variant_idstringObligatorio

    The id for the product variant.

  • visibilitystring

    The visibility of a product variant.

  • inventory_quantityinteger

    The inventory quantity of a product variant.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update promo codeMAILCHIMP_UPDATE_PROMO_CODEAcción

Update a promo code.

Parámetros de entrada

  • codestring

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

  • enabledboolean

    Whether the promo code is currently enabled.

  • store_idstringObligatorio

    The store id.

  • usage_countinteger

    Number of times promo code has been used.

  • promo_code_idstringObligatorio

    The id for the promo code of a store.

  • promo_rule_idstringObligatorio

    The id for the promo rule of a store.

  • redemption_urlstring

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

  • created_at_foreignstringdate-time

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

  • updated_at_foreignstringdate-time

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update promo ruleMAILCHIMP_UPDATE_PROMO_RULEAcción

Update a promo rule.

Parámetros de entrada

  • typestringenum

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

    fixedpercentage
  • titlestring

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

  • amountinteger

    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.

  • targetstringenum

    The target that the discount applies to.

    per_itemtotalshipping
  • enabledboolean

    Whether the promo rule is currently enabled.

  • ends_atstringPromo date-time

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

  • store_idstringObligatorio

    The store id.

  • starts_atstringdate-time

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

  • descriptionstring

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

  • promo_rule_idstringObligatorio

    The id for the promo rule of a store.

  • created_at_foreignstringdate-time

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

  • updated_at_foreignstringdate-time

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update storeMAILCHIMP_UPDATE_STOREAcción

Update a store.

Parámetros de entrada

  • namestring

    The name of the store.

  • phonestring

    The store phone number.

  • domainstring

    The store domain.

  • platformstring

    The e-commerce platform of the store.

  • store_idstringObligatorio

    The store id.

  • timezonestring

    The timezone for the store.

  • is_syncingboolean

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

  • money_formatstring

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

  • address__citystring

    The city the store is located in.

  • currency_codestring

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

  • email_addressstring

    The email address for the store.

  • primary_localestring

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

  • address__countrystring

    The store"s country.

  • address__address1string

    The store"s mailing address.

  • address__address2string

    An additional field for the store"s mailing address.

  • address__latitudeinteger

    The latitude of the store location.

  • address__provincestring

    The store"s state name or normalized province.

  • address__longitudeinteger

    The longitude of the store location.

  • address__postal__codestring

    The store"s postal or zip code.

  • address__country__codestring

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

  • address__province__codestring

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update templateMAILCHIMP_UPDATE_TEMPLATEAcción

Update the name, html, or `folder id` of an existing template.

Parámetros de entrada

  • htmlstringObligatorio

    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.

  • namestringObligatorio

    The name of the template.

  • folder_idstring

    The id of the folder the template is currently in.

  • template_idstringObligatorio

    The unique id for the template.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update template folderMAILCHIMP_UPDATE_TEMPLATE_FOLDERAcción

Update a specific folder used to organize templates.

Parámetros de entrada

  • namestringObligatorio

    The name of the folder.

  • folder_idstringObligatorio

    The unique id for the template folder.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update webhookMAILCHIMP_UPDATE_WEBHOOKAcción

Update the settings for an existing webhook.

Parámetros de entrada

  • urlstring

    A valid URL for the Webhook.

  • list_idstringObligatorio

    The unique ID for the list.

  • webhook_idstringObligatorio

    The webhook"s id.

  • sources__apiboolean

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

  • sources__userboolean

    Whether the webhook is triggered by subscriber-initiated actions.

  • sources__adminboolean

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

  • events__cleanedboolean

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

  • events__profileboolean

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

  • events__upemailboolean

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

  • events__campaignboolean

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

  • events__subscribeboolean

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

  • events__unsubscribeboolean

    Whether the webhook is triggered when a list member unsubscribes.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update workflow emailMAILCHIMP_UPDATE_WORKFLOW_EMAILAcción

Update settings for a classic automation workflow email. only works with workflows of type: abandonedbrowse, abandonedcart, emailfollowup, or singlewelcome.

Parámetros de entrada

  • delay__typestringenum

    The type of delay for an automation email.

    nowdayhourweek
  • workflow_idstringObligatorio

    The unique id for the Automation workflow.

  • delay__actionstringenum

    The action that triggers the delay of an automation emails.

    signupecomm_abandoned_browseecomm_abandoned_cart
  • delay__amountinteger

    The delay amount for an automation email.

  • settings__titlestring

    The title of the Automation.

  • delay__directionstringenum

    Whether the delay settings describe before or after the delay action of an automation email.

    after
  • workflow_email_idstringObligatorio

    The unique id for the Automation workflow email.

  • settings__reply__tostring

    The reply-to email address for the Automation.

  • settings__from__namestring

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

  • settings__preview__textstring

    The preview text for the campaign.

  • settings__subject__linestring

    The subject line for the campaign.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Verify connected site scriptMAILCHIMP_VERIFY_CONNECTED_SITE_SCRIPTAcción

Verify that the connected sites script has been installed, either via the script url or fragment.

Parámetros de entrada

  • connected_site_idstringObligatorio

    The unique identifier for the site.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Verify domainMAILCHIMP_VERIFY_DOMAINAcción

Verify a domain for sending.

Parámetros de entrada

  • codestringObligatorio

    The code that was sent to the email address provided when adding a new domain to verify.

  • domain_namestringObligatorio

    The domain name.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

View default contentMAILCHIMP_VIEW_DEFAULT_CONTENTAcción

Get the sections that you can edit in a template, including each section's default content.

Parámetros de entrada

  • fieldsstring[]

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

  • template_idstringObligatorio

    The unique id for the template.

  • exclude_fieldsstring[]

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

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

View recent activityMAILCHIMP_VIEW_RECENT_ACTIVITYAcción

Get a member's activity on a specific list, including opens, clicks, and unsubscribes.

Parámetros de entrada

  • countinteger

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

  • fieldsstring[]

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

  • offsetinteger

    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.

  • list_idstringObligatorio

    The unique ID for the list.

  • exclude_fieldsstring[]

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

  • subscriber_hashstringObligatorio

    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.

  • activity_filtersstring[]

    A comma-separated list of activity filters that correspond to a set of activity types, e.g "?activity_filters=open,bounce,click".

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

View recent activity 50MAILCHIMP_VIEW_RECENT_ACTIVITY50Acción

Get the last 50 events of a member's activity on a specific list, including opens, clicks, and unsubscribes.

Parámetros de entrada

  • actionstring[]

    A comma seperated list of actions to return.

  • fieldsstring[]

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

  • list_idstringObligatorio

    The unique ID for the list.

  • exclude_fieldsstring[]

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

  • subscriber_hashstringObligatorio

    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.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Triggers (4)

Los triggers son eventos externos que pueden iniciar un flujo en tus agentes (ej: nuevo email, mensaje recibido, registro creado).

Campaign TriggerMAILCHIMP_CAMPAIGN_TRIGGERTrigger

Triggered when a campaign is sent or experiences an event in Mailchimp

Configuración

  • list_idstringObligatorio

    The Mailchimp list/audience ID to monitor

Payload del evento

  • emailstring

    Email address of the subscriber

  • event_typestring

    Type of event

  • list_idstring

    ID of the list/audience

  • merge_fieldsobject

    Custom merge fields/data

  • timestampstring

    When the event occurred

Profile Update TriggerMAILCHIMP_PROFILE_UPDATE_TRIGGERTrigger

Triggered when a subscriber's profile is updated in Mailchimp

Configuración

  • list_idstringObligatorio

    The Mailchimp list/audience ID to monitor

Payload del evento

  • emailstring

    Email address of the subscriber

  • event_typestring

    Type of event

  • list_idstring

    ID of the list/audience

  • merge_fieldsobject

    Custom merge fields/data

  • timestampstring

    When the event occurred

Subscribe TriggerMAILCHIMP_SUBSCRIBE_TRIGGERTrigger

Triggered when a subscriber subscribes to Mailchimp

Configuración

  • list_idstringObligatorio

    The Mailchimp list/audience ID to monitor

Payload del evento

  • emailstring

    Email address of the subscriber

  • event_typestring

    Type of event

  • list_idstring

    ID of the list/audience

  • merge_fieldsobject

    Custom merge fields/data

  • timestampstring

    When the event occurred

Unsubscribe TriggerMAILCHIMP_UNSUBSCRIBE_TRIGGERTrigger

Triggered when a subscriber unsubscribes from Mailchimp

Configuración

  • list_idstringObligatorio

    The Mailchimp list/audience ID to monitor

Payload del evento

  • emailstring

    Email address of the subscriber

  • event_typestring

    Type of event

  • list_idstring

    ID of the list/audience

  • merge_fieldsobject

    Custom merge fields/data

  • timestampstring

    When the event occurred