7.0.0 • Published 5 years ago

@datafire/mailchimp v7.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/mailchimp

Client library for MailChimp Marketing API

Installation and Usage

npm install --save @datafire/mailchimp
let mailchimp = require('@datafire/mailchimp').create({
  apiKey: ""
});

.then(data => {
  console.log(data);
});

Description

Actions

getRoot

Get links to all other resources available in the API.

mailchimp.getRoot({}, context)

Input

  • input object
    • fields array: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
    • exclude_fields array: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

getAuthorizedApps

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

mailchimp.getAuthorizedApps({}, context)

Input

  • input object
    • fields array: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
    • exclude_fields array: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
    • count integer: The number of records to return. Default value is 10.
    • offset integer: The number of records from a collection to skip. Iterating over large collections with this parameter can be slow. Default value is 0.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

  • output object
    • apps array: An array of objects, each representing an authorized application.
      • items object
        • id integer: The ID for the application.
        • name string: The name of the application.
        • description string: A short description of the application.
        • users array: An array of usernames for users who have linked the app.
          • items string
        • _links HATEOASLinks
    • total_items CollectionTotal
    • _links HATEOASLinks

postAuthorizedApps

Retrieve OAuth2-based credentials to associate API calls with your application.

mailchimp.postAuthorizedApps({
  "Client Details": {
    "client_id": "",
    "client_secret": ""
  }
}, context)

Input

  • input object
    • Client Details required object
      • client_id required string: The client's unique id/username for authorization.
      • client_secret required string: The client password for authorization.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

  • output object
    • access_token string: The access token issued by the auth server.
    • viewer_token string: The viewer token issued by the auth server.
    • _links HATEOASLinks

getAuthorizedAppsId

Get information about a specific authorized application.

mailchimp.getAuthorizedAppsId({
  "app_id": ""
}, context)

Input

  • input object
    • fields array: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
    • exclude_fields array: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
    • app_id required string: The unique id for the connected authorized application.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

  • output object
    • id integer: The ID for the application.
    • name string: The name of the application.
    • description string: A short description of the application.
    • users array: An array of usernames for users who have linked the app.
      • items string
    • _links HATEOASLinks

getAutomations

Get a summary of an account's Automations.

mailchimp.getAutomations({}, context)

Input

  • input object
    • fields array: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
    • exclude_fields array: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
    • before_create_time string: Restrict the response to automations created before the set time. We recommend ISO 8601 time format: 2015-10-21T15:41:36+00:00.
    • since_create_time string: Restrict the response to automations created after the set time. We recommend ISO 8601 time format: 2015-10-21T15:41:36+00:00.
    • before_send_time string: Restrict the response to automations sent before the set time. We recommend ISO 8601 time format: 2015-10-21T15:41:36+00:00.
    • since_send_time string: Restrict the response to automations sent after the set time. We recommend ISO 8601 time format: 2015-10-21T15:41:36+00:00.
    • status string (values: save, paused, sending): Restrict the results to automations with the specified status.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

  • output object
    • automations array: An array of objects, each representing an Automation workflow.
      • items object: A summary of an individual Automation workflow's settings and content.
        • id string: A string that identifies the Automation.
        • create_time string: The date and time the Automation was created.
        • start_time string: The date and time the Automation was started.
        • status string (values: save, paused, sending): The current status of the Automation.
        • emails_sent integer: The total number of emails sent for the Automation.
        • recipients object: List settings for the Automation.
          • list_id string: The unique list id.
          • list_name string: List Name.
          • segment_opts object: An object representing all segmentation options.
            • saved_segment_id integer: The id for an existing saved segment.
            • match string (values: any, all): Segment match type.
            • conditions array: An array of segment conditions.
        • settings object: The settings for the Automation workflow.
          • title string: The title of the Automation.
          • from_name string: The 'from' name for the Automation (not an email address).
          • reply_to string: The reply-to email address for the Automation.
          • use_conversation boolean: Whether to use MailChimp's Conversations feature to manage out-of-office replies.
          • to_name string: The Automation's custom 'To' name, typically the first name merge field.
          • authenticate boolean: Whether MailChimp authenticated the Automation. Defaults to true.
          • auto_footer boolean: Whether to automatically append MailChimp's default footer to the Automation.
          • inline_css boolean: Whether to automatically inline the CSS included with the Automation content.
        • tracking object: The tracking options for the Automation.
          • opens boolean: Whether to track opens. Defaults to true.
          • html_clicks boolean: Whether to track clicks in the HTML version of the Automation. Defaults to true.
          • text_clicks boolean: Whether to track clicks in the plain-text version of the Automation. Defaults to true.
          • goal_tracking boolean: Whether to enable Goal tracking.
          • ecomm360 boolean: Whether to enable eCommerce360 tracking.
          • google_analytics string: The custom slug for Google Analytics tracking (max of 50 bytes).
          • clicktale string: The custom slug for ClickTale tracking (max of 50 bytes).
          • salesforce object: Salesforce tracking options for an Automation. Must be using MailChimp's built-in Salesforce integration.
            • campaign boolean: Create a campaign in a connected Salesforce account.
            • notes boolean: Update contact notes for a campaign based on a subscriber's email address.
          • capsule object: Capsule tracking options for an Automation. Must be using MailChimp's built-in Capsule integration.
            • notes boolean: Update contact notes for a campaign based on a subscriber's email addresses.
        • trigger_settings AutomationTrigger
        • report_summary object: A summary of opens, clicks, and unsubscribes for sent campaigns.
          • opens integer: The total number of opens for a campaign.
          • unique_opens integer: The number of unique opens.
          • open_rate number: The number of unique opens divided by the total number of successful deliveries.
          • clicks integer: The total number of clicks for an campaign.
          • subscriber_clicks integer: The number of unique clicks.
          • click_rate number: The number of unique clicks, divided by the total number of successful deliveries.
        • _links HATEOASLinks
    • total_items CollectionTotal
    • _links HATEOASLinks

getAutomationsId

Get a summary of an individual Automation workflow's settings and content. The trigger_settings object returns information for the first email in the workflow.

mailchimp.getAutomationsId({
  "workflow_id": ""
}, context)

Input

  • input object
    • fields array: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
    • exclude_fields array: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
    • workflow_id required string: The unique id for the Automation workflow.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

  • output object: A summary of an individual Automation workflow's settings and content.
    • id string: A string that identifies the Automation.
    • create_time string: The date and time the Automation was created.
    • start_time string: The date and time the Automation was started.
    • status string (values: save, paused, sending): The current status of the Automation.
    • emails_sent integer: The total number of emails sent for the Automation.
    • recipients object: List settings for the Automation.
      • list_id string: The unique list id.
      • list_name string: List Name.
      • segment_opts object: An object representing all segmentation options.
        • saved_segment_id integer: The id for an existing saved segment.
        • match string (values: any, all): Segment match type.
        • conditions array: An array of segment conditions.
    • settings object: The settings for the Automation workflow.
      • title string: The title of the Automation.
      • from_name string: The 'from' name for the Automation (not an email address).
      • reply_to string: The reply-to email address for the Automation.
      • use_conversation boolean: Whether to use MailChimp's Conversations feature to manage out-of-office replies.
      • to_name string: The Automation's custom 'To' name, typically the first name merge field.
      • authenticate boolean: Whether MailChimp authenticated the Automation. Defaults to true.
      • auto_footer boolean: Whether to automatically append MailChimp's default footer to the Automation.
      • inline_css boolean: Whether to automatically inline the CSS included with the Automation content.
    • tracking object: The tracking options for the Automation.
      • opens boolean: Whether to track opens. Defaults to true.
      • html_clicks boolean: Whether to track clicks in the HTML version of the Automation. Defaults to true.
      • text_clicks boolean: Whether to track clicks in the plain-text version of the Automation. Defaults to true.
      • goal_tracking boolean: Whether to enable Goal tracking.
      • ecomm360 boolean: Whether to enable eCommerce360 tracking.
      • google_analytics string: The custom slug for Google Analytics tracking (max of 50 bytes).
      • clicktale string: The custom slug for ClickTale tracking (max of 50 bytes).
      • salesforce object: Salesforce tracking options for an Automation. Must be using MailChimp's built-in Salesforce integration.
        • campaign boolean: Create a campaign in a connected Salesforce account.
        • notes boolean: Update contact notes for a campaign based on a subscriber's email address.
      • capsule object: Capsule tracking options for an Automation. Must be using MailChimp's built-in Capsule integration.
        • notes boolean: Update contact notes for a campaign based on a subscriber's email addresses.
    • trigger_settings AutomationTrigger
    • report_summary object: A summary of opens, clicks, and unsubscribes for sent campaigns.
      • opens integer: The total number of opens for a campaign.
      • unique_opens integer: The number of unique opens.
      • open_rate number: The number of unique opens divided by the total number of successful deliveries.
      • clicks integer: The total number of clicks for an campaign.
      • subscriber_clicks integer: The number of unique clicks.
      • click_rate number: The number of unique clicks, divided by the total number of successful deliveries.
    • _links HATEOASLinks

postAutomationsIdActionsPauseAllEmails

Pause all emails in a specific Automation workflow.

mailchimp.postAutomationsIdActionsPauseAllEmails({
  "workflow_id": ""
}, context)

Input

  • input object
    • workflow_id required string: The unique id for the Automation workflow.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

Output schema unknown

postAutomationsIdActionsStartAllEmails

Start all emails in an Automation workflow.

mailchimp.postAutomationsIdActionsStartAllEmails({
  "workflow_id": ""
}, context)

Input

  • input object
    • workflow_id required string: The unique id for the Automation workflow.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

Output schema unknown

getAutomationsIdEmails

Get a summary of the emails in an Automation workflow.

mailchimp.getAutomationsIdEmails({
  "workflow_id": ""
}, context)

Input

  • input object
    • workflow_id required string: The unique id for the Automation workflow.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

  • output object: A summary of the emails in an Automation workflow.
    • emails array: An array of objects, each representing an email in an Automation workflow.
      • items object: A summary of an individual Automation workflow email.
        • id string: A string that uniquely identifies the Automation email.
        • web_id integer: The ID used in the MailChimp web application. View this automation in your MailChimp account at https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}.
        • workflow_id string: A string that uniquely identifies an Automation workflow.
        • position integer: The position of an Automation email in a workflow.
        • delay object: The delay settings for an Automation email.
          • amount integer: The delay amount for an Automation email.
          • type string (values: now, day, hour, week): The type of delay for an Automation email.
          • direction string (values: before, after): Whether the delay settings describe before or after the delay action of an Automation email.
          • action string (values: previous_campaign_sent, previous_campaign_opened, previous_campaign_not_opened, previous_campaign_clicked_any, previous_campaign_not_clicked_any, previous_campaign_specific_clicked, ecomm_bought_any, ecomm_bought_product, ecomm_bought_category, ecomm_not_bought_any, ecomm_abandoned_cart, campaign_sent, opened_email, not_opened_email, clicked_email, not_clicked_email, campaign_specific_clicked, manual, signup, merge_changed, group_add, group_remove, mandrill_sent, mandrill_opened, mandrill_clicked, mandrill_any, api, goal, annual, birthday, date, date_added): The action that triggers the delay of an Automation email.
          • action_description string: The user-friendly description of the action that triggers an Automation email.
          • full_description string: The user-friendly description of the delay and trigger action settings for an Automation email.
        • create_time string: The date and time the campaign was created.
        • start_time string: The date and time the campaign was started.
        • archive_url string: The link to the campaign's archive version.
        • status string (values: save, paused, sending): The current status of the campaign.
        • emails_sent integer: The total number of emails sent for this campaign.
        • send_time string: The date and time a campaign was sent.
        • content_type string: How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url').
        • recipients object: List settings for the campaign.
        • settings object: Settings for the campaign including the email subject, from name, and from email address.
          • subject_line string: The subject line for the campaign.
          • preview_text string: The preview text for the campaign.
          • title string: The title of the campaign.
          • from_name string: The 'from' name on the campaign (not an email address).
          • reply_to string: The reply-to email address for the campaign.
          • authenticate boolean: Whether MailChimp authenticated the campaign. Defaults to true.
          • auto_footer boolean: Automatically append MailChimp's default footer to the campaign.
          • inline_css boolean: Automatically inline the CSS included with the campaign content.
          • auto_tweet boolean: Automatically tweet a link to the campaign archive page when the campaign is sent.
          • auto_fb_post array: An array of Facebook page ids to auto-post to.
          • fb_comments boolean: Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to true.
          • template_id integer: The id for the template used in this campaign.
          • drag_and_drop boolean: Whether the campaign uses the drag-and-drop editor.
        • tracking object: The tracking options for a campaign.
          • opens boolean: Whether to track opens. Defaults to true.
          • html_clicks boolean: Whether to track clicks in the HTML version of the campaign. Defaults to true.
          • text_clicks boolean: Whether to track clicks in the plain-text version of the campaign. Defaults to true.
          • goal_tracking boolean: Whether to enable Goal tracking.
          • ecomm360 boolean: Whether to enable eCommerce360 tracking.
          • google_analytics string: The custom slug for Google Analytics tracking (max of 50 bytes).
          • clicktale string: The custom slug for Click Tale tracking (max of 50 bytes).
          • salesforce object: Salesforce tracking options for a campaign. Must be using MailChimp's built-in Salesforce integration.
            • campaign boolean: Create a campaign in a connected Salesforce account.
            • notes boolean: Update contact notes for a campaign based on a subscriber's email address.
          • capsule object: Capsule tracking option for a campaign. Must be using MailChimp's built-in Capsule integration.
            • notes boolean: Update contact notes for a campaign based on a subscriber's email address.
        • social_card object: The preview for the campaign, rendered by social networks like Facebook and Twitter. Learn more.
          • image_url string: The url for the header image for the card.
          • description string: A short summary of the campaign to display.
          • title string: The title for the card. Typically the subject line of the campaign.
        • trigger_settings AutomationTrigger
        • report_summary object: For sent campaigns, a summary of opens, clicks, and unsubscribes.
          • opens integer: The total number of opens for a campaign.
          • unique_opens integer: The number of unique opens.
          • open_rate number: The number of unique opens divided by the total number of successful deliveries.
          • clicks integer: The total number of clicks for an campaign.
          • subscriber_clicks integer: The number of unique clicks.
          • click_rate number: The number of unique clicks divided by the total number of successful deliveries.
        • _links HATEOASLinks
    • total_items CollectionTotal
    • _links HATEOASLinks

getAutomationsIdEmailsId

Get information about an individual Automation workflow email.

mailchimp.getAutomationsIdEmailsId({
  "workflow_id": "",
  "workflow_email_id": ""
}, context)

Input

  • input object
    • workflow_id required string: The unique id for the Automation workflow.
    • workflow_email_id required string: The unique id for the Automation workflow email.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

  • output object: A summary of an individual Automation workflow email.
    • id string: A string that uniquely identifies the Automation email.
    • web_id integer: The ID used in the MailChimp web application. View this automation in your MailChimp account at https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}.
    • workflow_id string: A string that uniquely identifies an Automation workflow.
    • position integer: The position of an Automation email in a workflow.
    • delay object: The delay settings for an Automation email.
      • amount integer: The delay amount for an Automation email.
      • type string (values: now, day, hour, week): The type of delay for an Automation email.
      • direction string (values: before, after): Whether the delay settings describe before or after the delay action of an Automation email.
      • action string (values: previous_campaign_sent, previous_campaign_opened, previous_campaign_not_opened, previous_campaign_clicked_any, previous_campaign_not_clicked_any, previous_campaign_specific_clicked, ecomm_bought_any, ecomm_bought_product, ecomm_bought_category, ecomm_not_bought_any, ecomm_abandoned_cart, campaign_sent, opened_email, not_opened_email, clicked_email, not_clicked_email, campaign_specific_clicked, manual, signup, merge_changed, group_add, group_remove, mandrill_sent, mandrill_opened, mandrill_clicked, mandrill_any, api, goal, annual, birthday, date, date_added): The action that triggers the delay of an Automation email.
      • action_description string: The user-friendly description of the action that triggers an Automation email.
      • full_description string: The user-friendly description of the delay and trigger action settings for an Automation email.
    • create_time string: The date and time the campaign was created.
    • start_time string: The date and time the campaign was started.
    • archive_url string: The link to the campaign's archive version.
    • status string (values: save, paused, sending): The current status of the campaign.
    • emails_sent integer: The total number of emails sent for this campaign.
    • send_time string: The date and time a campaign was sent.
    • content_type string: How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url').
    • recipients object: List settings for the campaign.
    • settings object: Settings for the campaign including the email subject, from name, and from email address.
      • subject_line string: The subject line for the campaign.
      • preview_text string: The preview text for the campaign.
      • title string: The title of the campaign.
      • from_name string: The 'from' name on the campaign (not an email address).
      • reply_to string: The reply-to email address for the campaign.
      • authenticate boolean: Whether MailChimp authenticated the campaign. Defaults to true.
      • auto_footer boolean: Automatically append MailChimp's default footer to the campaign.
      • inline_css boolean: Automatically inline the CSS included with the campaign content.
      • auto_tweet boolean: Automatically tweet a link to the campaign archive page when the campaign is sent.
      • auto_fb_post array: An array of Facebook page ids to auto-post to.
      • fb_comments boolean: Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to true.
      • template_id integer: The id for the template used in this campaign.
      • drag_and_drop boolean: Whether the campaign uses the drag-and-drop editor.
    • tracking object: The tracking options for a campaign.
      • opens boolean: Whether to track opens. Defaults to true.
      • html_clicks boolean: Whether to track clicks in the HTML version of the campaign. Defaults to true.
      • text_clicks boolean: Whether to track clicks in the plain-text version of the campaign. Defaults to true.
      • goal_tracking boolean: Whether to enable Goal tracking.
      • ecomm360 boolean: Whether to enable eCommerce360 tracking.
      • google_analytics string: The custom slug for Google Analytics tracking (max of 50 bytes).
      • clicktale string: The custom slug for Click Tale tracking (max of 50 bytes).
      • salesforce object: Salesforce tracking options for a campaign. Must be using MailChimp's built-in Salesforce integration.
        • campaign boolean: Create a campaign in a connected Salesforce account.
        • notes boolean: Update contact notes for a campaign based on a subscriber's email address.
      • capsule object: Capsule tracking option for a campaign. Must be using MailChimp's built-in Capsule integration.
        • notes boolean: Update contact notes for a campaign based on a subscriber's email address.
    • social_card object: The preview for the campaign, rendered by social networks like Facebook and Twitter. Learn more.
      • image_url string: The url for the header image for the card.
      • description string: A short summary of the campaign to display.
      • title string: The title for the card. Typically the subject line of the campaign.
    • trigger_settings AutomationTrigger
    • report_summary object: For sent campaigns, a summary of opens, clicks, and unsubscribes.
      • opens integer: The total number of opens for a campaign.
      • unique_opens integer: The number of unique opens.
      • open_rate number: The number of unique opens divided by the total number of successful deliveries.
      • clicks integer: The total number of clicks for an campaign.
      • subscriber_clicks integer: The number of unique clicks.
      • click_rate number: The number of unique clicks divided by the total number of successful deliveries.
    • _links HATEOASLinks

deleteAutomationsIdEmailsId

Removes an individual Automation workflow email. Emails from certain workflow types, including the Abandoned Cart Email (abandonedCart) and Product Retargeting Email (abandonedBrowse) Workflows, cannot be deleted.

mailchimp.deleteAutomationsIdEmailsId({
  "workflow_id": "",
  "workflow_email_id": ""
}, context)

Input

  • input object
    • workflow_id required string: The unique id for the Automation workflow.
    • workflow_email_id required string: The unique id for the Automation workflow email.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

Output schema unknown

getAutomationsIdEmailsIdQueue

Get information about an Automation email queue.

mailchimp.getAutomationsIdEmailsIdQueue({
  "workflow_id": "",
  "workflow_email_id": ""
}, context)

Input

  • input object
    • workflow_id required string: The unique id for the Automation workflow.
    • workflow_email_id required string: The unique id for the Automation workflow email.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

  • output object
    • workflow_id string: A string that uniquely identifies an Automation workflow.
    • email_id string: A string that uniquely identifies an email in an Automation workflow.
    • queue array: An array of objects, each representing a subscriber queue for an email in an Automation workflow.
    • total_items CollectionTotal
    • _links HATEOASLinks

postAutomationsIdEmailsIdQueue

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 or add subscribers to an automated email queue that uses the API request delay type.

mailchimp.postAutomationsIdEmailsIdQueue({
  "workflow_id": "",
  "workflow_email_id": "",
  "body": {
    "email_address": ""
  }
}, context)

Input

  • input object
    • workflow_id required string: The unique id for the Automation workflow.
    • workflow_email_id required string: The unique id for the Automation workflow email.
    • body required object: Information about subscribers in an Automation email queue.
      • email_address required string: The list member's email address.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

  • output object: Information about subscribers in an Automation email queue.
    • id string: The MD5 hash of the lowercase version of the list member's email address.
    • workflow_id string: A string that uniquely identifies an Automation workflow.
    • email_id string: A string that uniquely identifies an email in an Automation workflow.
    • list_id string: A string that uniquely identifies a list.
    • email_address string: The list member's email address.
    • next_send string: The date and time of the next send for the workflow email.
    • _links HATEOASLinks

getAutomationsIdEmailsIdQueueId

Get information about a specific subscriber in an Automation email queue.

mailchimp.getAutomationsIdEmailsIdQueueId({
  "workflow_id": "",
  "workflow_email_id": "",
  "subscriber_hash": ""
}, context)

Input

  • input object
    • workflow_id required string: The unique id for the Automation workflow.
    • workflow_email_id required string: The unique id for the Automation workflow email.
    • subscriber_hash required string: The MD5 hash of the lowercase version of the list member's email address.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

  • output object: Information about subscribers in an Automation email queue.
    • id string: The MD5 hash of the lowercase version of the list member's email address.
    • workflow_id string: A string that uniquely identifies an Automation workflow.
    • email_id string: A string that uniquely identifies an email in an Automation workflow.
    • list_id string: A string that uniquely identifies a list.
    • email_address string: The list member's email address.
    • next_send string: The date and time of the next send for the workflow email.
    • _links HATEOASLinks

postAutomationsIdEmailsIdActionsPause

Pause an automated email.

mailchimp.postAutomationsIdEmailsIdActionsPause({
  "workflow_id": "",
  "workflow_email_id": ""
}, context)

Input

  • input object
    • workflow_id required string: The unique id for the Automation workflow.
    • workflow_email_id required string: The unique id for the Automation workflow email.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

Output schema unknown

postAutomationsIdEmailsIdActionsStart

Start an automated email.

mailchimp.postAutomationsIdEmailsIdActionsStart({
  "workflow_id": "",
  "workflow_email_id": ""
}, context)

Input

  • input object
    • workflow_id required string: The unique id for the Automation workflow.
    • workflow_email_id required string: The unique id for the Automation workflow email.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

Output schema unknown

getAutomationsIdRemovedSubscribers

Get information about subscribers who were removed from an Automation workflow.

mailchimp.getAutomationsIdRemovedSubscribers({
  "workflow_id": ""
}, context)

Input

  • input object
    • workflow_id required string: The unique id for the Automation workflow.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

  • output object: A summary of the subscribers who were removed from an Automation workflow.
    • workflow_id string: A string that uniquely identifies an Automation workflow.
    • subscribers array: An array of objects, each representing a subscriber who was removed from an Automation workflow.
      • items object: A summary of a subscriber removed from an Automation workflow.
        • id string: The MD5 hash of the lowercase version of the list member's email address.
        • workflow_id string: A string that uniquely identifies an Automation workflow.
        • list_id string: A string that uniquely identifies a list.
        • email_address string: The list member's email address.
        • _links HATEOASLinks
    • total_items CollectionTotal
    • _links HATEOASLinks

postAutomationsIdRemovedSubscribers

Remove a subscriber from a specific Automation workflow. You can remove a subscriber at any point in an Automation workflow, regardless of how many emails they've been sent from that workflow. Once they're removed, they can never be added back to the same workflow.

mailchimp.postAutomationsIdRemovedSubscribers({
  "workflow_id": "",
  "body": {
    "email_address": ""
  }
}, context)

Input

  • input object
    • workflow_id required string: The unique id for the Automation workflow.
    • body required object: Information about subscribers in an Automation email queue.
      • email_address required string: The list member's email address.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

  • output object: A summary of a subscriber removed from an Automation workflow.
    • id string: The MD5 hash of the lowercase version of the list member's email address.
    • workflow_id string: A string that uniquely identifies an Automation workflow.
    • list_id string: A string that uniquely identifies a list.
    • email_address string: The list member's email address.
    • _links HATEOASLinks

getAutomationsIdRemovedSubscribersId

Get information about a specific subscriber who was removed from an Automation workflow.

mailchimp.getAutomationsIdRemovedSubscribersId({
  "workflow_id": "",
  "subscriber_hash": ""
}, context)

Input

  • input object
    • workflow_id required string: The unique id for the Automation workflow.
    • subscriber_hash required string: The MD5 hash of the lowercase version of the list member's email address.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

  • output object: A summary of a subscriber removed from an Automation workflow.
    • id string: The MD5 hash of the lowercase version of the list member's email address.
    • workflow_id string: A string that uniquely identifies an Automation workflow.
    • list_id string: A string that uniquely identifies a list.
    • email_address string: The list member's email address.
    • _links HATEOASLinks

getBatches

Get a summary of batch requests that have been made.

mailchimp.getBatches({}, context)

Input

  • input object
    • fields array: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
    • exclude_fields array: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
    • count integer: The number of records to return. Default value is 10.
    • offset integer: The number of records from a collection to skip. Iterating over large collections with this parameter can be slow. Default value is 0.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

  • output object: A summary of batch requests that have been made.
    • batches array: An array of objects representing batch calls.
      • items object: The status of a batch request
        • id string: A string that uniquely identifies this batch request.
        • status string (values: pending, preprocessing, started, finalizing, finished): The status of the batch call. Learn more about how batch operations are processed.
        • total_operations integer: The total number of operations to complete as part of this batch request. For GET requests requiring pagination, each page counts as a separate operation.
        • finished_operations integer: The number of completed operations. This includes operations that returned an error.
        • errored_operations integer: The number of completed operations that returned an error.
        • submitted_at string: The date and time when the server received the batch request.
        • completed_at string: The date and time when all operations in the batch request completed.
        • response_body_url string: The URL of the gzipped archive of the results of all the operations.
        • _links HATEOASLinks
    • total_items CollectionTotal
    • _links HATEOASLinks

postBatches

Begin processing a batch operations request.

mailchimp.postBatches({
  "body": {}
}, context)

Input

  • input object
    • body required object
      • operations array: An array of objects that describes operations to perform.
        • items object
          • method required string: The HTTP method to use for the operation.
          • path required string: The relative path to use for the operation.
          • params object: Any URL params to use, only applies to GET operations.
          • body string: A string containing the JSON body to use with the request.
          • operation_id string: An optional client-supplied id returned with the operation results.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

  • output object: The status of a batch request
    • id string: A string that uniquely identifies this batch request.
    • status string (values: pending, preprocessing, started, finalizing, finished): The status of the batch call. Learn more about how batch operations are processed.
    • total_operations integer: The total number of operations to complete as part of this batch request. For GET requests requiring pagination, each page counts as a separate operation.
    • finished_operations integer: The number of completed operations. This includes operations that returned an error.
    • errored_operations integer: The number of completed operations that returned an error.
    • submitted_at string: The date and time when the server received the batch request.
    • completed_at string: The date and time when all operations in the batch request completed.
    • response_body_url string: The URL of the gzipped archive of the results of all the operations.
    • _links HATEOASLinks

getBatchesId

Get the status of a batch request.

mailchimp.getBatchesId({
  "batch_id": ""
}, context)

Input

  • input object
    • fields array: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
    • exclude_fields array: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
    • batch_id required string: The unique id for the batch operation.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

  • output object: The status of a batch request
    • id string: A string that uniquely identifies this batch request.
    • status string (values: pending, preprocessing, started, finalizing, finished): The status of the batch call. Learn more about how batch operations are processed.
    • total_operations integer: The total number of operations to complete as part of this batch request. For GET requests requiring pagination, each page counts as a separate operation.
    • finished_operations integer: The number of completed operations. This includes operations that returned an error.
    • errored_operations integer: The number of completed operations that returned an error.
    • submitted_at string: The date and time when the server received the batch request.
    • completed_at string: The date and time when all operations in the batch request completed.
    • response_body_url string: The URL of the gzipped archive of the results of all the operations.
    • _links HATEOASLinks

deleteBatchesId

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.

mailchimp.deleteBatchesId({
  "batch_id": ""
}, context)

Input

  • input object
    • batch_id required string: The unique id for the batch operation.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

Output schema unknown

getBatchWebhooks

Get all webhooks that have been configured for batches.

mailchimp.getBatchWebhooks({}, context)

Input

  • input object
    • fields array: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
    • exclude_fields array: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
    • count integer: The number of records to return. Default value is 10.
    • offset integer: The number of records from a collection to skip. Iterating over large collections with this parameter can be slow. Default value is 0.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

  • output object: Manage webhooks for batch requests.
    • webhooks array: An array of objects, each representing a Batch Webhook.
      • items object: A webook configured for batch status updates.
        • id string: A string that uniquely identifies this Batch Webhook.
        • url string: A valid URL for the Webhook.
        • _links HATEOASLinks
    • total_items CollectionTotal
    • _links HATEOASLinks

postBatchWebhooks

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

mailchimp.postBatchWebhooks({
  "body": {
    "url": ""
  }
}, context)

Input

  • input object
    • body required object: Add a new Batch Webook.
      • url required string: A valid URL for the Webhook.
      • _links HATEOASLinks
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

  • output object: A webook configured for batch status updates.
    • id string: A string that uniquely identifies this Batch Webhook.
    • url string: A valid URL for the Webhook.
    • _links HATEOASLinks

getBatchWebhook

Get information about a specific batch webhook.

mailchimp.getBatchWebhook({
  "batch_webhook_id": ""
}, context)

Input

  • input object
    • fields array: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
    • exclude_fields array: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
    • batch_webhook_id required string: The unique id for the batch webhook.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

  • output object: A webook configured for batch status updates.
    • id string: A string that uniquely identifies this Batch Webhook.
    • url string: A valid URL for the Webhook.
    • _links HATEOASLinks

patchBatchWebhooks

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

mailchimp.patchBatchWebhooks({
  "batch_webhook_id": "",
  "body": {
    "url": ""
  }
}, context)

Input

  • input object
    • batch_webhook_id required string: The unique id for the batch webhook.
    • body required object: Update an existing Batch Webook.
      • url required string: A valid URL for the Webhook.
      • _links HATEOASLinks
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

  • output object: A webook configured for batch status updates.
    • id string: A string that uniquely identifies this Batch Webhook.
    • url string: A valid URL for the Webhook.
    • _links HATEOASLinks

deleteBatchWebhookId

Remove a batch webhook. Webhooks will no longer be sent to the given URL.

mailchimp.deleteBatchWebhookId({
  "batch_webhook_id": ""
}, context)

Input

  • input object
    • batch_webhook_id required string: The unique id for the batch webhook.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

Output schema unknown

getTemplateFolders

Get all folders used to organize templates.

mailchimp.getTemplateFolders({}, context)

Input

  • input object
    • fields array: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
    • exclude_fields array: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
    • count integer: The number of records to return. Default value is 10.
    • offset integer: The number of records from a collection to skip. Iterating over large collections with this parameter can be slow. Default value is 0.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

  • output object: A list of template folders
    • folders array: An array of objects representing template folders.
      • items object: A folder used to organize templates.
        • name string: The name of the folder.
        • id string: A string that uniquely identifies this template folder.
        • count integer: The number of templates in the folder.
        • _links HATEOASLinks
    • total_items CollectionTotal
    • _links HATEOASLinks

postTemplateFolders

Create a new template folder.

mailchimp.postTemplateFolders({
  "body": {
    "name": ""
  }
}, context)

Input

  • input object
    • body required object: A folder used to organize templates.
      • name required string: The name of the folder.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

  • output object: A folder used to organize templates.
    • name string: The name of the folder.
    • id string: A string that uniquely identifies this template folder.
    • count integer: The number of templates in the folder.
    • _links HATEOASLinks

getTemplateFoldersId

Get information about a specific folder used to organize templates.

mailchimp.getTemplateFoldersId({
  "folder_id": ""
}, context)

Input

  • input object
    • fields array: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
    • exclude_fields array: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
    • folder_id required string: The unique id for the template folder.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

  • output object: A folder used to organize templates.
    • name string: The name of the folder.
    • id string: A string that uniquely identifies this template folder.
    • count integer: The number of templates in the folder.
    • _links HATEOASLinks

patchTemplateFoldersId

Update a specific folder used to organize templates.

mailchimp.patchTemplateFoldersId({
  "folder_id": "",
  "body": {
    "name": ""
  }
}, context)

Input

  • input object
    • folder_id required string: The unique id for the template folder.
    • body required object: A folder used to organize templates.
      • name required string: The name of the folder.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

  • output object: A folder used to organize templates.
    • name string: The name of the folder.
    • id string: A string that uniquely identifies this template folder.
    • count integer: The number of templates in the folder.
    • _links HATEOASLinks

deleteTemplateFoldersId

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

mailchimp.deleteTemplateFoldersId({
  "folder_id": ""
}, context)

Input

  • input object
    • folder_id required string: The unique id for the template folder.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

Output schema unknown

getCampaignFolders

Get all folders used to organize campaigns.

mailchimp.getCampaignFolders({}, context)

Input

  • input object
    • fields array: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
    • exclude_fields array: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
    • count integer: The number of records to return. Default value is 10.
    • offset integer: The number of records from a collection to skip. Iterating over large collections with this parameter can be slow. Default value is 0.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

  • output object: A list of campaign folders
    • folders array: An array of objects representing campaign folders.
      • items object: A folder used to organize campaigns.
        • name string: The name of the folder.
        • id string: A string that uniquely identifies this campaign folder.
        • count integer: The number of campaigns in the folder.
        • _links HATEOASLinks
    • total_items CollectionTotal
    • _links HATEOASLinks

postCampaignFolders

Create a new campaign folder.

mailchimp.postCampaignFolders({
  "body": {
    "name": ""
  }
}, context)

Input

  • input object
    • body required object: A folder used to organize campaigns.
      • name required string: Name to associate with the folder.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

  • output object: A folder used to organize campaigns.
    • name string: The name of the folder.
    • id string: A string that uniquely identifies this campaign folder.
    • count integer: The number of campaigns in the folder.
    • _links HATEOASLinks

getCampaignFoldersId

Get information about a specific folder used to organize campaigns.

mailchimp.getCampaignFoldersId({
  "folder_id": ""
}, context)

Input

  • input object
    • fields array: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
    • exclude_fields array: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
    • folder_id required string: The unique id for the campaign folder.
    • dc string: dc corresponds to the data center for your account. For example, if the last part of your MailChimp API key is us6, set dc to "us6"

Output

  • output object: A folder used to organize campaigns.
    • name string: The name of the folder.
    • id string: A string that uniquely identifies this campaign folder.
    • count integer: The number of campaigns in the folder.
    • _links HATEOASLinks

patchCampaignFoldersId

Update a specific folder used to organize campaigns.

mailchimp.patchCampaignFoldersId({
  "folder_id": "",
  "body": {
    "name": ""
  }
}, context)

Input

  • input object
    • folder_id required string: The unique id for the campaign folder.
    • body required object: A folder used to organize camp
datafire
@infinitebrahmanuniverse/nolb-_datafire_m@everything-registry/sub-chunk-222@zalastax/nolb-_datafire_m
7.0.0

5 years ago

6.0.0

7 years ago

5.0.0

7 years ago

4.0.0

8 years ago

3.0.1

8 years ago

2.0.2

8 years ago

2.0.1

8 years ago