Skip to content

slingr-stack/mailchimp-endpoint

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

title keywords last_updated tags summary
MailChimp endpoint
April 27, 2023
Detailed description of the API of the MailChimp endpoint.

Overview

The MailChimp endpoint allows to sync email activity and campaign stats with your database, manage lists, view and control automation workflows, and test different calls and endpoints before pushing to production.

Some of the features are:

  • Authentication
  • Shortcuts for the REST API
  • Helpers to convert date times

In most cases you will be using the provided shortcuts to access the API. For example, you could use the REST API directly by doing an HTTP request like this:

var res = app.endpoints.mailchimp.get('/lists');

However you probably want to use the shortcuts:

var res = app.endpoints.mailchimp.lists.get();

These shortcuts are based on the Mailchimp REST API. You can see more information about that in the shortcuts section.

Quick start

One common integration case with Mailchimp is the management of lists. For example, when a you add a new contact to your app you might want to add a member to a list:

var res = app.endpoints.mailchimp.lists.members.post(defaultListId, {
  email_address: record.field('email').val(),
  status: record.field('subscribed').val() ? 'subscribed' : 'unsubscribed',
  merge_fields: {
    FNAME: record.field('firstName').val(),
    LNAME: record.field('lastName').val()
  }
});
record.field('mailchimpSubscriberId').val(res.data.unique_email_id);
sys.data.save(record);

Additionally, if a user unsubscribes, you can remove catch the webhook with a listener and mark the contact as unsubscribed:

var webhook = event.data.body;
sys.logs.info('Processing Mailchimp webhook of type ['+webhook.type+']');
if (webhook.type == 'unsubscribe') {
  var contact = sys.data.findOne('contacts', {mailchimpSubscriberId: webhook.data.id});
  if (contact) {
    contact.field('subscribed').val(false);
    sys.data.save(contact);
  }    
}

Configuration

First you will need to setup an account in MailChimp. Then you will be able to configure the endpoint you will need to generate an API key. You can find more information about that here.

API key

This is the API key generated by following the process here. Just copy the generated API key to this field.

Webhook URL

This is the URL you should configure for webhooks in Mailchimp. Notice that you need to configure the webhook URL on each MailChimp list. Please refer to the webhooks documentation for more information on how to configure them.

Javascript API

The Javascript API of the Mailchimp endpoint has three pieces:

  • HTTP request: this allows to make regular HTTP requests like GET, POST or PUT to the API.
  • Shortcuts: these are helpers to make HTTP request to the API in a more convenient way.
  • Date helpers: allow to easily convert dates from/to Mailchimp so they can be used easily in SLINGR.

HTTP requests

You can make GET, POST, PUT, and DELETE request to the MailChimp API like this:

var lists = app.endpoints.mailchimp.get('/lists');
var newCampaignFolder = app.endpoints.mailchimp.post('/campaign-folders', { "name": "NewFolderName" });

Please take a look at the documentation of the HTTP endpoint for more information.

Shortcuts

Instead of having to use the generic HTTP methods, you can make use of the shortcuts provided in the endpoint. These shortcuts follow these rules:

  • Path sections get converted to namespaces: for example if the method is GET ~/ecommerce/stores/{store_id}/carts/{cart_id} it is converted to app.endpoints.mailchimp.ecommerce.stores.carts.get(storeId, cartIdid2).
  • If they have dashes, we should convert them to camel case: ~/file-manager/files is converted to app.endpoints.mailchimp.fileManager.files.get().
  • HTTP method is appended at the end of the method: for example if the method is GET, you will see a method with the suffix .get(...). For example GET ~/campaigns/{campaign_id} will become app.endpoints.mailchimp.campaigns.get(id). This is the mapping of names:
    • GET: get
    • POST: create
    • PUT: update
    • PATCH: update
    • DELETE: delete
  • Path variables become method parameters: if the method has variables in the path, they will become parameters for the method. For example GET ~/conversations/{conversation_id}/messages/{message_id} will become app.endpoints.mailchimp.conversations.messages.get(conversationId, messageId).
  • Additional parameters or body are sent in the last param as JSON: if the method accepts more parameters or it allows to send a body, that will be sent in the last parameter. For example the method POST ~/campaigns/{campaign_id}/feedback supports many query parameters, so it will become app.endpoints.mailchimp.campaigns.feedback.post(campaignId, {...}).

Here are some URLs of the REST API and their corresponding shortcut:

// GET /campaigns
var res = app.endpoints.mailchimp.campaigns.get();

// GET /campaigns/{campaign_id}
var res = app.endpoints.mailchimp.campaigns.get(campaignId);

// GET /lists/{list_id}/members
var res = app.endpoints.mailchimp.lists.members.get(listId, params);

// POST /lists/{list_id}/members
var res = app.endpoints.mailchimp.lists.members.post(listId, body);

Upload files

When uploading files it is possible to send the ID of a file in the SLINGR app and the endpoint will automatically read and send it to MailChimp:

var res = app.endpoints.mailchimp.fileManager.files.post({
  file_id: fileId, 
  name: 'test.png',
  folder_id: folderId
});

Where file_id is the ID of a file in the SLINGR app and you should send it instead of file_data as indicated in MailChimp API. It returns the same as POST /file-manager/files.

For example:

var res = app.endpoints.mailchimp.fileManager.files.post({
  file_id: record.field('file').id(), 
  name: 'test.png'
});

Date helpers

MailChimp date use following format for dates yyyy-MM-dd'T'HH:mm:ssX. The following methods help to convert dates to make it easy to work with SLINGR:

// converts a Mailchimp date to milliseconds
var timestamp = app.endpoints.mailchimp.dates.toMillis('2017-07-19T13:12:56+00:00');

// converts a Mailchimp date to a Date object
var date = app.endpoints.mailchimp.dates.toDate('2017-07-19T13:12:56+00:00');

// converts milliseconds to a Mailchimp date
var mailchimpDate = app.endpoints.mailchimp.dates.fromMillis(1500469976000);

// converts a Date object to a Mailchimp date
var mailchimpDate = app.endpoints.mailchimp.dates.fromDate(new Date());

Email helper

var md5 = app.endpoints.mailchimp.emailHash(email);

Returns the MD5 hash of the email. This is needed when you need to work with members in list.

Events

Webhook

Changes in lists like member subscriptions or unsubscriptions will be notified through this event. Keep in mind that you need to configure webhooks on each list. See the documentation here for more information.

According to the documentation of the format of webhooks you should get key-value pairs like when there is an HTML form submission. However, to make it easier, we convert it to JSON. For example, instead of getting this:

"type": "subscribe", 
"fired_at": "2009-03-26 21:35:57", 
"data[id]": "8a25ff1d98", 
"data[list_id]": "a6b5da1054",
"data[email]": "api@mailchimp.com", 
"data[email_type]": "html", 
"data[merges][EMAIL]": "api@mailchimp.com", 
"data[merges][FNAME]": "MailChimp", 
"data[merges][LNAME]": "API", 
"data[merges][INTERESTS]": "Group1,Group2", 
"data[ip_opt]": "10.20.10.30", 
"data[ip_signup]": "10.20.10.30"

You will get this:

{
    type: "subscribe", 
    fired_at: "2009-03-26 21:35:57", 
    data: {
        id: "8a25ff1d98", 
        list_id: "a6b5da1054",
        email: "api@mailchimp.com", 
        email_type: "html", 
        merges: {
            EMAIL: "api@mailchimp.com", 
            FNAME: "MailChimp", 
            LNAME: "API", 
            INTERESTS: "Group1,Group2"
        },
        ip_opt: "10.20.10.30", 
        ip_signup: "10.20.10.30"
    }
}

About SLINGR

SLINGR is a low-code rapid application development platform that accelerates development, with robust architecture for integrations and executing custom workflows and automation.

More info about SLINGR

License

This endpoint is licensed under the Apache License 2.0. See the LICENSE file for more details.

MailChimp v1.0.0

Javascript API

The Javascript API of the mailchimp endpoint has three pieces:

  • HTTP requests: These allow to make regular HTTP requests.
  • Shortcuts: These are helpers to make HTTP request to the API in a more convenient way.
  • Additional Helpers: These helpers provide additional features that facilitate or improves the endpoint usage in SLINGR.

HTTP requests

You can make PATCH,POST,GET,DELETE,PUT requests to the mailchimp API like this:

var response = app.endpoints.mailchimp.patch('/lists/:list_id/members/:subscriber_hash', body)
var response = app.endpoints.mailchimp.patch('/lists/:list_id/members/:subscriber_hash')
var response = app.endpoints.mailchimp.post('/file-manager/files', body)
var response = app.endpoints.mailchimp.post('/file-manager/files')
var response = app.endpoints.mailchimp.get('/ecommerce/stores/:store_id/carts/:cart_id/lines/:line_id')
var response = app.endpoints.mailchimp.delete('/lists/:list_id/interest-categories/:interest_category_id/interests/:interest_id')
var response = app.endpoints.mailchimp.put('/ecommerce/stores/:store_id/products/:product_id/variants/:variant_id', body)
var response = app.endpoints.mailchimp.put('/ecommerce/stores/:store_id/products/:product_id/variants/:variant_id')

Please take a look at the documentation of the HTTP endpoint for more information about generic requests.

Shortcuts

Instead of having to use the generic HTTP methods, you can (and should) make use of the helpers provided in the endpoint:

Click here to see all the helpers
  • API URL: '/batch-webhooks/:batch_webhook_id'
  • HTTP Method: 'PATCH'
app.endpoints.mailchimp.batchWebhooks.patch(batchWebhookId, body)

  • API URL: '/campaign-folders/:folder_id'
  • HTTP Method: 'PATCH'
app.endpoints.mailchimp.campaignFolders.patch(folderId, body)

  • API URL: '/campaigns/:campaign_id'
  • HTTP Method: 'PATCH'
app.endpoints.mailchimp.campaigns.patch(campaignId, body)

  • API URL: '/campaigns/:campaign_id/feedback/:feedback_id'
  • HTTP Method: 'PATCH'
app.endpoints.mailchimp.campaigns.feedback.patch(campaignId, feedbackId, body)

  • API URL: '/ecommerce/stores/:store_id'
  • HTTP Method: 'PATCH'
app.endpoints.mailchimp.ecommerce.stores.patch(storeId, body)

  • API URL: '/ecommerce/stores/:store_id/carts/:cart_id'
  • HTTP Method: 'PATCH'
app.endpoints.mailchimp.ecommerce.stores.carts.patch(storeId, cartId, body)

  • API URL: '/ecommerce/stores/:store_id/carts/:cart_id/lines/:line_id'
  • HTTP Method: 'PATCH'
app.endpoints.mailchimp.ecommerce.stores.carts.lines.patch(storeId, cartId, lineId, body)

  • API URL: '/ecommerce/stores/:store_id/customers/:customer_id'
  • HTTP Method: 'PATCH'
app.endpoints.mailchimp.ecommerce.stores.customers.patch(storeId, customerId, body)

  • API URL: '/ecommerce/stores/:store_id/orders/:order_id'
  • HTTP Method: 'PATCH'
app.endpoints.mailchimp.ecommerce.stores.orders.patch(storeId, orderId, body)

  • API URL: '/ecommerce/stores/:store_id/orders/:order_id/lines/:line_id'
  • HTTP Method: 'PATCH'
app.endpoints.mailchimp.ecommerce.stores.orders.lines.patch(storeId, orderId, lineId, body)

  • API URL: '/ecommerce/stores/:store_id/products/:product_id'
  • HTTP Method: 'PATCH'
app.endpoints.mailchimp.ecommerce.stores.products.patch(storeId, productId, body)

  • API URL: '/ecommerce/stores/:store_id/products/:product_id/images/:image_id'
  • HTTP Method: 'PATCH'
app.endpoints.mailchimp.ecommerce.stores.products.images.patch(storeId, productId, imageId, body)

  • API URL: '/ecommerce/stores/:store_id/products/:product_id/variants/:variant_id'
  • HTTP Method: 'PATCH'
app.endpoints.mailchimp.ecommerce.stores.products.variants.patch(storeId, productId, variantId, body)

  • API URL: '/file-manager/files/:file_id'
  • HTTP Method: 'PATCH'
app.endpoints.mailchimp.fileManager.files.patch(fileId, body)

  • API URL: '/file-manager/folders/:folder_id'
  • HTTP Method: 'PATCH'
app.endpoints.mailchimp.fileManager.folders.patch(folderId, body)

  • API URL: '/lists/:list_id'
  • HTTP Method: 'PATCH'
app.endpoints.mailchimp.lists.patch(listId, body)

  • API URL: '/lists/:list_id/interest-categories/:interest_category_id'
  • HTTP Method: 'PATCH'
app.endpoints.mailchimp.lists.interestCategories.patch(listId, interestCategoryId, body)

  • API URL: '/lists/:list_id/interest-categories/:interest_category_id/interests/:interest_id'
  • HTTP Method: 'PATCH'
app.endpoints.mailchimp.lists.interestCategories.interests.patch(listId, interestCategoryId, interestId, body)

  • API URL: '/lists/:list_id/members/:subscriber_hash'
  • HTTP Method: 'PATCH'
app.endpoints.mailchimp.lists.members.patch(listId, subscriberHash, body)

  • API URL: '/lists/:list_id/members/:subscriber_hash/notes/:note_id'
  • HTTP Method: 'PATCH'
app.endpoints.mailchimp.lists.members.notes.patch(listId, subscriberHash, noteId, body)

  • API URL: '/lists/:list_id/merge-fields/:merge_id'
  • HTTP Method: 'PATCH'
app.endpoints.mailchimp.lists.mergeFields.patch(listId, mergeId, body)

  • API URL: '/lists/:list_id/segments/:segment_id'
  • HTTP Method: 'PATCH'
app.endpoints.mailchimp.lists.segments.patch(listId, segmentId, body)

  • API URL: '/lists/:list_id/webhooks/:webhook_id'
  • HTTP Method: 'PATCH'
app.endpoints.mailchimp.lists.webhooks.patch(listId, webhookId, body)

  • API URL: '/template-folders/:folder_id'
  • HTTP Method: 'PATCH'
app.endpoints.mailchimp.templateFolders.patch(folderId, body)

  • API URL: '/templates/:template_id'
  • HTTP Method: 'PATCH'
app.endpoints.mailchimp.templates.patch(templateId, body)

  • API URL: '/authorized-apps'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.authorizedApps.post(body)

  • API URL: '/automations/:workflow_id/actions/pause-all-emails'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.automations.actions.pauseAllEmails.post(workflowId, body)

  • API URL: '/automations/:workflow_id/actions/start-all-emails'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.automations.actions.startAllEmails.post(workflowId, body)

  • API URL: '/automations/:workflow_id/emails/:workflow_email_id/actions/pause'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.automations.emails.actions.pause.post(workflowId, workflowEmailId, body)

  • API URL: '/automations/:workflow_id/emails/:workflow_email_id/actions/start'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.automations.emails.actions.start.post(workflowId, workflowEmailId, body)

  • API URL: '/automations/:workflow_id/emails/:workflow_email_id/queue'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.automations.emails.queue.post(workflowId, workflowEmailId, body)

  • API URL: '/automations/:workflow_id/removed-subscribers'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.automations.removedSubscribers.post(workflowId, body)

  • API URL: '/batches'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.batches.post(body)

  • API URL: '/batch-webhooks'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.batchWebhooks.post(body)

  • API URL: '/campaign-folders'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.campaignFolders.post(body)

  • API URL: '/campaigns'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.campaigns.post(body)

  • API URL: '/campaigns/:campaign_id/actions/cancel-send'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.campaigns.actions.cancelSend.post(campaignId, body)

  • API URL: '/campaigns/:campaign_id/actions/pause'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.campaigns.actions.pause.post(campaignId, body)

  • API URL: '/campaigns/:campaign_id/actions/replicate'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.campaigns.actions.replicate.post(campaignId, body)

  • API URL: '/campaigns/:campaign_id/actions/resume'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.campaigns.actions.resume.post(campaignId, body)

  • API URL: '/campaigns/:campaign_id/actions/schedule'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.campaigns.actions.schedule.post(campaignId, body)

  • API URL: '/campaigns/:campaign_id/actions/send'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.campaigns.actions.send.post(campaignId, body)

  • API URL: '/campaigns/:campaign_id/actions/test'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.campaigns.actions.test.post(campaignId, body)

  • API URL: '/campaigns/:campaign_id/actions/unschedule'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.campaigns.actions.unschedule.post(campaignId, body)

  • API URL: '/campaigns/:campaign_id/feedback'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.campaigns.feedback.post(campaignId, body)

  • API URL: '/conversations/:conversation_id/messages'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.conversations.messages.post(conversationId, body)

  • API URL: '/ecommerce/stores'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.ecommerce.stores.post(body)

  • API URL: '/ecommerce/stores/:store_id/carts'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.ecommerce.stores.carts.post(body)

  • API URL: '/ecommerce/stores/:store_id/carts/:cart_id'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.ecommerce.stores.carts.post(storeId, body)

  • API URL: '/ecommerce/stores/:store_id/carts/:cart_id/lines'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.ecommerce.stores.carts.lines.post(storeId, cartId, body)

  • API URL: '/ecommerce/stores/:store_id/customers'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.ecommerce.stores.customers.post(storeId, body)

  • API URL: '/ecommerce/stores/:store_id/orders'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.ecommerce.stores.orders.post(storeId, body)

  • API URL: '/ecommerce/stores/:store_id/products'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.ecommerce.stores.products.post(storeId, body)

  • API URL: '/ecommerce/stores/:store_id/products/:product_id/images'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.ecommerce.stores.products.images.post(storeId, productId, body)

  • API URL: '/ecommerce/stores/:store_id/products/:product_id/variants'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.ecommerce.stores.products.variants.post(storeId, productId, body)

  • API URL: '/file-manager/files'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.fileManager.files.post(body)

  • API URL: '/file-manager/folders'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.fileManager.folders.post(body)

  • API URL: '/lists'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.lists.post(body)

  • API URL: '/lists/:list_id'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.lists.post(body)

  • API URL: '/lists/:list_id/interest-categories'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.lists.interestCategories.post(body)

  • API URL: '/lists/:list_id/interest-categories/:interest_category_id'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.lists.interestCategories.post(listId, body)

  • API URL: '/lists/:list_id/interest-categories/:interest_category_id/interests'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.lists.interestCategories.interests.post(listId, interestCategoryId, body)

  • API URL: '/lists/:list_id/members'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.lists.members.post(listId, body)

  • API URL: '/lists/:list_id/members/:subscriber_hash/notes'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.lists.members.notes.post(listId, subscriberHash, body)

  • API URL: '/lists/:list_id/merge-fields'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.lists.mergeFields.post(listId, body)

  • API URL: '/lists/:list_id/segments'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.lists.segments.post(body)

  • API URL: '/lists/:list_id/segments/:segment_id'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.lists.segments.post(listId, body)

  • API URL: '/lists/:list_id/segments/:segment_id/members'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.lists.segments.members.post(listId, segmentId, body)

  • API URL: '/lists/:list_id/signup-forms'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.lists.signupForms.post(listId, body)

  • API URL: '/lists/:list_id/webhooks'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.lists.webhooks.post(listId, body)

  • API URL: '/template-folders'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.templateFolders.post(body)

  • API URL: '/templates'
  • HTTP Method: 'POST'
app.endpoints.mailchimp.templates.post(body)

  • API URL: '/authorized-apps'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.authorizedApps.get()

  • API URL: '/authorized-apps/:app_id'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.authorizedApps.get()

  • API URL: '/automations'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.automations.get()

  • API URL: '/automations/:workflow_id'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.automations.get()

  • API URL: '/automations/:workflow_id/emails'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.automations.emails.get()

  • API URL: '/automations/:workflow_id/emails/:workflow_email_id'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.automations.emails.get(workflowId)

  • API URL: '/automations/:workflow_id/emails/:workflow_email_id/queue'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.automations.emails.queue.get(workflowId)

  • API URL: '/automations/:workflow_id/emails/:workflow_email_id/queue/:subscriber_hash'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.automations.emails.queue.get(workflowId, workflowEmailId)

  • API URL: '/automations/:workflow_id/removed-subscribers'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.automations.removedSubscribers.get(workflowId)

  • API URL: '/batches'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.batches.get()

  • API URL: '/batches/:batch_id'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.batches.get()

  • API URL: '/batch-webhooks'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.batchWebhooks.get()

  • API URL: '/batch-webhooks/:batch_webhook_id'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.batchWebhooks.get()

  • API URL: '/campaign-folders'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.campaignFolders.get()

  • API URL: '/campaign-folders/:folder_id'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.campaignFolders.get()

  • API URL: '/campaigns'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.campaigns.get()

  • API URL: '/campaigns/:campaign_id'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.campaigns.get()

  • API URL: '/campaigns/:campaign_id/content'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.campaigns.content.get(campaignId)

  • API URL: '/campaigns/:campaign_id/feedback'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.campaigns.feedback.get()

  • API URL: '/campaigns/:campaign_id/feedback/:feedback_id'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.campaigns.feedback.get(campaignId)

  • API URL: '/campaigns/:campaign_id/send-checklist'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.campaigns.sendChecklist.get(campaignId)

  • API URL: '/conversations'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.conversations.get()

  • API URL: '/conversations/:conversation_id'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.conversations.get()

  • API URL: '/conversations/:conversation_id/messages'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.conversations.messages.get()

  • API URL: '/conversations/:conversation_id/messages/:message_id'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.conversations.messages.get(conversationId)

  • API URL: '/ecommerce/stores'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.ecommerce.stores.get()

  • API URL: '/ecommerce/stores/:store_id'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.ecommerce.stores.get()

  • API URL: '/ecommerce/stores/:store_id/carts/:cart_id/lines'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.ecommerce.stores.carts.lines.get(storeId)

  • API URL: '/ecommerce/stores/:store_id/carts/:cart_id/lines/:line_id'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.ecommerce.stores.carts.lines.get(storeId, cartId)

  • API URL: '/ecommerce/stores/:store_id/customers'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.ecommerce.stores.customers.get()

  • API URL: '/ecommerce/stores/:store_id/customers/:customer_id'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.ecommerce.stores.customers.get(storeId)

  • API URL: '/ecommerce/stores/:store_id/orders'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.ecommerce.stores.orders.get()

  • API URL: '/ecommerce/stores/:store_id/orders/:order_id'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.ecommerce.stores.orders.get(storeId)

  • API URL: '/ecommerce/stores/:store_id/orders/:order_id/lines'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.ecommerce.stores.orders.lines.get(storeId)

  • API URL: '/ecommerce/stores/:store_id/orders/:order_id/lines/:line_id'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.ecommerce.stores.orders.lines.get(storeId, orderId)

  • API URL: '/ecommerce/stores/:store_id/products'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.ecommerce.stores.products.get()

  • API URL: '/ecommerce/stores/:store_id/products/:product_id'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.ecommerce.stores.products.get(storeId)

  • API URL: '/ecommerce/stores/:store_id/products/:product_id/images'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.ecommerce.stores.products.images.get(storeId)

  • API URL: '/ecommerce/stores/:store_id/products/:product_id/images/:image_id'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.ecommerce.stores.products.images.get(storeId, productId)

  • API URL: '/ecommerce/stores/:store_id/products/:product_id/variants'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.ecommerce.stores.products.variants.get(storeId)

  • API URL: '/ecommerce/stores/:store_id/products/:product_id/variants/:variant_id'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.ecommerce.stores.products.variants.get(storeId, productId)

  • API URL: '/file-manager/files'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.fileManager.files.get()

  • API URL: '/file-manager/files/:file_id'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.fileManager.files.get()

  • API URL: '/file-manager/folders'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.fileManager.folders.get()

  • API URL: '/file-manager/folders/:folder_id'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.fileManager.folders.get()

  • API URL: '/lists'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.lists.get()

  • API URL: '/lists/:list_id'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.lists.get()

  • API URL: '/lists/:list_id/abuse-reports'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.lists.abuseReports.get()

  • API URL: '/lists/:list_id/abuse-reports/:report_id'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.lists.abuseReports.get(listId)

  • API URL: '/lists/:list_id/activity'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.lists.activity.get(listId)

  • API URL: '/lists/:list_id/clients'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.lists.clients.get(listId)

  • API URL: '/lists/:list_id/growth-history'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.lists.growthHistory.get()

  • API URL: '/lists/:list_id/growth-history/:month'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.lists.growthHistory.get(listId)

  • API URL: '/lists/:list_id/interest-categories/:interest_category_id/interests'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.lists.interestCategories.interests.get(listId)

  • API URL: '/lists/:list_id/interest-categories/:interest_category_id/interests/:interest_id'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.lists.interestCategories.interests.get(listId, interestCategoryId)

  • API URL: '/lists/:list_id/locations'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.lists.locations.get(listId)

  • API URL: '/lists/:list_id/members'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.lists.members.get()

  • API URL: '/lists/:list_id/members/:subscriber_hash'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.lists.members.get(listId)

  • API URL: '/lists/:list_id/members/:subscriber_hash/activity'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.lists.members.activity.get(listId, subscriberHash)

  • API URL: '/lists/:list_id/members/:subscriber_hash/goals'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.lists.members.goals.get(listId, subscriberHash)

  • API URL: '/lists/:list_id/members/:subscriber_hash/notes'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.lists.members.notes.get(listId)

  • API URL: '/lists/:list_id/members/:subscriber_hash/notes/:note_id'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.lists.members.notes.get(listId, subscriberHash)

  • API URL: '/lists/:list_id/merge-fields'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.lists.mergeFields.get()

  • API URL: '/lists/:list_id/merge-fields/:merge_id'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.lists.mergeFields.get(listId)

  • API URL: '/lists/:list_id/segments'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.lists.segments.get()

  • API URL: '/lists/:list_id/segments/:segment_id'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.lists.segments.get(listId)

  • API URL: '/lists/:list_id/segments/:segment_id/members'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.lists.segments.members.get(listId, segmentId)

  • API URL: '/lists/:list_id/signup-forms'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.lists.signupForms.get(listId)

  • API URL: '/lists/:list_id/webhooks'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.lists.webhooks.get()

  • API URL: '/lists/:list_id/webhooks/:webhook_id'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.lists.webhooks.get(listId)

  • API URL: '/reports'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.reports.get()

  • API URL: '/reports/:campaign_id'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.reports.get()

  • API URL: '/reports/:campaign_id/abuse-reports'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.reports.abuseReports.get()

  • API URL: '/reports/:campaign_id/abuse-reports/:report_id'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.reports.abuseReports.get(campaignId)

  • API URL: '/reports/:campaign_id/advice'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.reports.advice.get(campaignId)

  • API URL: '/reports/:campaign_id/click-details'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.reports.clickDetails.get()

  • API URL: '/reports/:campaign_id/click-details/:link_id'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.reports.clickDetails.get(campaignId)

  • API URL: '/reports/:campaign_id/click-details/:link_id/members'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.reports.clickDetails.members.get(campaignId)

  • API URL: '/reports/:campaign_id/click-details/:link_id/members/:subscriber_hash'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.reports.clickDetails.members.get(campaignId, linkId)

  • API URL: '/reports/:campaign_id/domain-performance'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.reports.domainPerformance.get(campaignId)

  • API URL: '/reports/:campaign_id/eepurl'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.reports.eepurl.get(campaignId)

  • API URL: '/reports/:campaign_id/email-activity'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.reports.emailActivity.get()

  • API URL: '/reports/:campaign_id/email-activity/:subscriber_hash'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.reports.emailActivity.get(campaignId)

  • API URL: '/reports/:campaign_id/locations'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.reports.locations.get(campaignId)

  • API URL: '/reports/:campaign_id/sent-to'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.reports.sentTo.get()

  • API URL: '/reports/:campaign_id/sent-to/:subscriber_hash'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.reports.sentTo.get(campaignId)

  • API URL: '/reports/:campaign_id/sub-reports'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.reports.subReports.get(campaignId)

  • API URL: '/reports/:campaign_id/unsubscribed'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.reports.unsubscribed.get()

  • API URL: '/reports/:campaign_id/unsubscribed/:subscriber_hash'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.reports.unsubscribed.get(campaignId)

  • API URL: '/search-campaigns'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.searchCampaigns.get()

  • API URL: '/search-members'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.searchMembers.get()

  • API URL: '/template-folders'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.templateFolders.get()

  • API URL: '/template-folders/:folder_id'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.templateFolders.get()

  • API URL: '/templates'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.templates.get()

  • API URL: '/templates/:template_id'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.templates.get()

  • API URL: '/templates/:template_id/default-content'
  • HTTP Method: 'GET'
app.endpoints.mailchimp.templates.defaultContent.get(templateId)

  • API URL: '/automations/:workflow_id/emails/:workflow_email_id'
  • HTTP Method: 'DELETE'
app.endpoints.mailchimp.automations.emails.delete(workflowId, workflowEmailId)

  • API URL: '/batches/:batch_id'
  • HTTP Method: 'DELETE'
app.endpoints.mailchimp.batches.delete(batchId)

  • API URL: '/batch-webhooks/:batch_webhook_id'
  • HTTP Method: 'DELETE'
app.endpoints.mailchimp.batchWebhooks.delete(batchWebhookId)

  • API URL: '/campaign-folders/:folder_id'
  • HTTP Method: 'DELETE'
app.endpoints.mailchimp.campaignFolders.delete(folderId)

  • API URL: '/campaigns/:campaign_id'
  • HTTP Method: 'DELETE'
app.endpoints.mailchimp.campaigns.delete(campaignId)

  • API URL: '/campaigns/:campaign_id/feedback/:feedback_id'
  • HTTP Method: 'DELETE'
app.endpoints.mailchimp.campaigns.feedback.delete(campaignId, feedbackId)

  • API URL: '/ecommerce/stores/:store_id'
  • HTTP Method: 'DELETE'
app.endpoints.mailchimp.ecommerce.stores.delete(storeId)

  • API URL: '/ecommerce/stores/:store_id/carts/:cart_id'
  • HTTP Method: 'DELETE'
app.endpoints.mailchimp.ecommerce.stores.carts.delete(storeId, cartId)

  • API URL: '/ecommerce/stores/:store_id/carts/:cart_id/lines/:line_id'
  • HTTP Method: 'DELETE'
app.endpoints.mailchimp.ecommerce.stores.carts.lines.delete(storeId, cartId, lineId)

  • API URL: '/ecommerce/stores/:store_id/customers/:customer_id'
  • HTTP Method: 'DELETE'
app.endpoints.mailchimp.ecommerce.stores.customers.delete(storeId, customerId)

  • API URL: '/ecommerce/stores/:store_id/orders/:order_id'
  • HTTP Method: 'DELETE'
app.endpoints.mailchimp.ecommerce.stores.orders.delete(storeId, orderId)

  • API URL: '/ecommerce/stores/:store_id/orders/:order_id/lines/:line_id'
  • HTTP Method: 'DELETE'
app.endpoints.mailchimp.ecommerce.stores.orders.lines.delete(storeId, orderId, lineId)

  • API URL: '/ecommerce/stores/:store_id/products/:product_id'
  • HTTP Method: 'DELETE'
app.endpoints.mailchimp.ecommerce.stores.products.delete(storeId, productId)

  • API URL: '/ecommerce/stores/:store_id/products/:product_id/images/:image_id'
  • HTTP Method: 'DELETE'
app.endpoints.mailchimp.ecommerce.stores.products.images.delete(storeId, productId, imageId)

  • API URL: '/ecommerce/stores/:store_id/products/:product_id/variants/:variant_id'
  • HTTP Method: 'DELETE'
app.endpoints.mailchimp.ecommerce.stores.products.variants.delete(storeId, productId, variantId)

  • API URL: '/file-manager/files/:file_id'
  • HTTP Method: 'DELETE'
app.endpoints.mailchimp.fileManager.files.delete(fileId)

  • API URL: '/file-manager/folders/:folder_id'
  • HTTP Method: 'DELETE'
app.endpoints.mailchimp.fileManager.folders.delete(folderId)

  • API URL: '/lists/:list_id'
  • HTTP Method: 'DELETE'
app.endpoints.mailchimp.lists.delete(listId)

  • API URL: '/lists/:list_id/interest-categories/:interest_category_id'
  • HTTP Method: 'DELETE'
app.endpoints.mailchimp.lists.interestCategories.delete(listId, interestCategoryId)

  • API URL: '/lists/:list_id/interest-categories/:interest_category_id/interests/:interest_id'
  • HTTP Method: 'DELETE'
app.endpoints.mailchimp.lists.interestCategories.interests.delete(listId, interestCategoryId, interestId)

  • API URL: '/lists/:list_id/members/:subscriber_hash'
  • HTTP Method: 'DELETE'
app.endpoints.mailchimp.lists.members.delete(listId, subscriberHash)

  • API URL: '/lists/:list_id/members/:subscriber_hash/notes/:note_id'
  • HTTP Method: 'DELETE'
app.endpoints.mailchimp.lists.members.notes.delete(listId, subscriberHash, noteId)

  • API URL: '/lists/:list_id/merge-fields/:merge_id'
  • HTTP Method: 'DELETE'
app.endpoints.mailchimp.lists.mergeFields.delete(listId, mergeId)

  • API URL: '/lists/:list_id/segments/:segment_id'
  • HTTP Method: 'DELETE'
app.endpoints.mailchimp.lists.segments.delete(listId, segmentId)

  • API URL: '/lists/:list_id/segments/:segment_id/members/:subscriber_hash'
  • HTTP Method: 'DELETE'
app.endpoints.mailchimp.lists.segments.members.delete(listId, segmentId, subscriberHash)

  • API URL: '/lists/:list_id/webhooks/:webhook_id'
  • HTTP Method: 'DELETE'
app.endpoints.mailchimp.lists.webhooks.delete(listId, webhookId)

  • API URL: '/template-folders/:folder_id'
  • HTTP Method: 'DELETE'
app.endpoints.mailchimp.templateFolders.delete(folderId)

  • API URL: '/templates/:template_id'
  • HTTP Method: 'DELETE'
app.endpoints.mailchimp.templates.delete(templateId)

  • API URL: '/campaigns/:campaign_id/content'
  • HTTP Method: 'PUT'
app.endpoints.mailchimp.campaigns.content.put(campaignId, body)

  • API URL: '/ecommerce/stores/:store_id/customers/:customer_id'
  • HTTP Method: 'PUT'
app.endpoints.mailchimp.ecommerce.stores.customers.put(storeId, customerId, body)

  • API URL: '/ecommerce/stores/:store_id/products/:product_id/variants/:variant_id'
  • HTTP Method: 'PUT'
app.endpoints.mailchimp.ecommerce.stores.products.variants.put(storeId, productId, variantId, body)

  • API URL: '/lists/:list_id/members/:subscriber_hash'
  • HTTP Method: 'PUT'
app.endpoints.mailchimp.lists.members.put(listId, subscriberHash, body)

Flow Step

As an alternative option to using scripts, you can make use of Flows and Flow Steps specifically created for the endpoint:

Click here to see the Flow Steps

Generic Flow Step

Generic flow step for full use of the entire endpoint and its services.

Inputs

Label Type Required Default Visibility Description
URL (Method) choice yes - Always This is the http method to be used against the endpoint.
Possible values are:
PATCH,POST,GET,DELETE,PUT
URL (Path) choice yes - Always The url to which this endpoint will send the request. This is the exact service to which the http request will be made.
Possible values are:
/batch-webhooks/{batch_webhook_id}
/campaign-folders/{folder_id}
/campaigns/{campaign_id}
/campaigns/{campaign_id}/feedback/{feedback_id}
/ecommerce/stores/{store_id}
/ecommerce/stores/{store_id}/carts/{cart_id}
/ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}
/ecommerce/stores/{store_id}/customers/{customer_id}
/ecommerce/stores/{store_id}/orders/{order_id}
/ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}
/ecommerce/stores/{store_id}/products/{product_id}
/ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}
/ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}
/file-manager/files/{file_id}
/file-manager/folders/{folder_id}
/lists/{list_id}
/lists/{list_id}/interest-categories/{interest_category_id}
/lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}
/lists/{list_id}/members/{subscriber_hash}
/lists/{list_id}/members/{subscriber_hash}/notes/{note_id}
/lists/{list_id}/merge-fields/{merge_id}
/lists/{list_id}/segments/{segment_id}
/lists/{list_id}/webhooks/{webhook_id}
/template-folders/{folder_id}
/templates/{template_id}
/authorized-apps
/automations/{workflow_id}/actions/pause-all-emails
/automations/{workflow_id}/actions/start-all-emails
/automations/{workflow_id}/emails/{workflow_email_id}/actions/pause
/automations/{workflow_id}/emails/{workflow_email_id}/actions/start
/automations/{workflow_id}/emails/{workflow_email_id}/queue
/automations/{workflow_id}/removed-subscribers
/batches
/batch-webhooks
/campaign-folders
/campaigns
/campaigns/{campaign_id}/actions/cancel-send
/campaigns/{campaign_id}/actions/pause
/campaigns/{campaign_id}/actions/replicate
/campaigns/{campaign_id}/actions/resume
/campaigns/{campaign_id}/actions/schedule
/campaigns/{campaign_id}/actions/send
/campaigns/{campaign_id}/actions/test
/campaigns/{campaign_id}/actions/unschedule
/campaigns/{campaign_id}/feedback
/conversations/{conversation_id}/messages
/ecommerce/stores
/ecommerce/stores/{store_id}/carts
/ecommerce/stores/{store_id}/carts/{cart_id}
/ecommerce/stores/{store_id}/carts/{cart_id}/lines
/ecommerce/stores/{store_id}/customers
/ecommerce/stores/{store_id}/orders
/ecommerce/stores/{store_id}/products
/ecommerce/stores/{store_id}/products/{product_id}/images
/ecommerce/stores/{store_id}/products/{product_id}/variants
/file-manager/files
/file-manager/folders
/lists
/lists/{list_id}
/lists/{list_id}/interest-categories
/lists/{list_id}/interest-categories/{interest_category_id}
/lists/{list_id}/interest-categories/{interest_category_id}/interests
/lists/{list_id}/members
/lists/{list_id}/members/{subscriber_hash}/notes
/lists/{list_id}/merge-fields
/lists/{list_id}/segments
/lists/{list_id}/segments/{segment_id}
/lists/{list_id}/segments/{segment_id}/members
/lists/{list_id}/signup-forms
/lists/{list_id}/webhooks
/template-folders
/templates
/authorized-apps
/authorized-apps/{app_id}
/automations
/automations/{workflow_id}
/automations/{workflow_id}/emails
/automations/{workflow_id}/emails/{workflow_email_id}
/automations/{workflow_id}/emails/{workflow_email_id}/queue
/automations/{workflow_id}/emails/{workflow_email_id}/queue/{subscriber_hash}
/automations/{workflow_id}/removed-subscribers
/batches
/batches/{batch_id}
/batch-webhooks
/batch-webhooks/{batch_webhook_id}
/campaign-folders
/campaign-folders/{folder_id}
/campaigns
/campaigns/{campaign_id}
/campaigns/{campaign_id}/content
/campaigns/{campaign_id}/feedback
/campaigns/{campaign_id}/feedback/{feedback_id}
/campaigns/{campaign_id}/send-checklist
/conversations
/conversations/{conversation_id}
/conversations/{conversation_id}/messages
/conversations/{conversation_id}/messages/{message_id}
/ecommerce/stores
/ecommerce/stores/{store_id}
/ecommerce/stores/{store_id}/carts/{cart_id}/lines
/ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}
/ecommerce/stores/{store_id}/customers
/ecommerce/stores/{store_id}/customers/{customer_id}
/ecommerce/stores/{store_id}/orders
/ecommerce/stores/{store_id}/orders/{order_id}
/ecommerce/stores/{store_id}/orders/{order_id}/lines
/ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}
/ecommerce/stores/{store_id}/products
/ecommerce/stores/{store_id}/products/{product_id}
/ecommerce/stores/{store_id}/products/{product_id}/images
/ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}
/ecommerce/stores/{store_id}/products/{product_id}/variants
/ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}
/file-manager/files
/file-manager/files/{file_id}
/file-manager/folders
/file-manager/folders/{folder_id}
/lists
/lists/{list_id}
/lists/{list_id}/abuse-reports
/lists/{list_id}/abuse-reports/{report_id}
/lists/{list_id}/activity
/lists/{list_id}/clients
/lists/{list_id}/growth-history
/lists/{list_id}/growth-history/{month}
/lists/{list_id}/interest-categories/{interest_category_id}/interests
/lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}
/lists/{list_id}/locations
/lists/{list_id}/members
/lists/{list_id}/members/{subscriber_hash}
/lists/{list_id}/members/{subscriber_hash}/activity
/lists/{list_id}/members/{subscriber_hash}/goals
/lists/{list_id}/members/{subscriber_hash}/notes
/lists/{list_id}/members/{subscriber_hash}/notes/{note_id}
/lists/{list_id}/merge-fields
/lists/{list_id}/merge-fields/{merge_id}
/lists/{list_id}/segments
/lists/{list_id}/segments/{segment_id}
/lists/{list_id}/segments/{segment_id}/members
/lists/{list_id}/signup-forms
/lists/{list_id}/webhooks
/lists/{list_id}/webhooks/{webhook_id}
/reports
/reports/{campaign_id}
/reports/{campaign_id}/abuse-reports
/reports/{campaign_id}/abuse-reports/{report_id}
/reports/{campaign_id}/advice
/reports/{campaign_id}/click-details
/reports/{campaign_id}/click-details/{link_id}
/reports/{campaign_id}/click-details/{link_id}/members
/reports/{campaign_id}/click-details/{link_id}/members/{subscriber_hash}
/reports/{campaign_id}/domain-performance
/reports/{campaign_id}/eepurl
/reports/{campaign_id}/email-activity
/reports/{campaign_id}/email-activity/{subscriber_hash}
/reports/{campaign_id}/locations
/reports/{campaign_id}/sent-to
/reports/{campaign_id}/sent-to/{subscriber_hash}
/reports/{campaign_id}/sub-reports
/reports/{campaign_id}/unsubscribed
/reports/{campaign_id}/unsubscribed/{subscriber_hash}
/search-campaigns
/search-members
/template-folders
/template-folders/{folder_id}
/templates
/templates/{template_id}
/templates/{template_id}/default-content
/automations/{workflow_id}/emails/{workflow_email_id}
/batches/{batch_id}
/batch-webhooks/{batch_webhook_id}
/campaign-folders/{folder_id}
/campaigns/{campaign_id}
/campaigns/{campaign_id}/feedback/{feedback_id}
/ecommerce/stores/{store_id}
/ecommerce/stores/{store_id}/carts/{cart_id}
/ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}
/ecommerce/stores/{store_id}/customers/{customer_id}
/ecommerce/stores/{store_id}/orders/{order_id}
/ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}
/ecommerce/stores/{store_id}/products/{product_id}
/ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}
/ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}
/file-manager/files/{file_id}
/file-manager/folders/{folder_id}
/lists/{list_id}
/lists/{list_id}/interest-categories/{interest_category_id}
/lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}
/lists/{list_id}/members/{subscriber_hash}
/lists/{list_id}/members/{subscriber_hash}/notes/{note_id}
/lists/{list_id}/merge-fields/{merge_id}
/lists/{list_id}/segments/{segment_id}
/lists/{list_id}/segments/{segment_id}/members/{subscriber_hash}
/lists/{list_id}/webhooks/{webhook_id}
/template-folders/{folder_id}
/templates/{template_id}
/campaigns/{campaign_id}/content
/ecommerce/stores/{store_id}/customers/{customer_id}
/ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}
/lists/{list_id}/members/{subscriber_hash}
Headers keyValue no - Always Used when you want to have a custom http header for the request.
Query Params keyValue no - Always Used when you want to have a custom query params for the http call.
Body json no - Always A payload of data can be sent to the server in the body of the request.
Event dropDown no - Always Used to define event after the call.
Possible values are:
File Downloaded, Callback
Callback data textarea no - Event is Callback This is an object you can send that you will get back when the function is processed.
Callbacks Script no - Event is Callback This is a map where you can listen for different function
Override Settings boolean no false Always
Follow Redirect boolean no false overrideSettings Indicates that the resource has to be downloaded into a file instead of returning it in the response.
Download boolean no false overrideSettings If true the method won't return until the file has been downloaded, and it will return all the information of the file.
File name text no overrideSettings If provided, the file will be stored with this name. If empty the file name will be calculated from the URL.
Full response boolean no false overrideSettings Include extended information about response
Connection Timeout number no 5000 overrideSettings Connect timeout interval, in milliseconds (0 = infinity).
Read Timeout number no 60000 overrideSettings Read timeout interval, in milliseconds (0 = infinity).

Outputs

Name Type Description
response object Object resulting from the response to the endpoint call.

For more information about how shortcuts or flow steps works, and how they are generated, take a look at the slingr-helpgen tool.

Additional Flow Step

Click here to see the Customs Flow Steps

Custom Flow Steps Name

Description of Custom Flow Steps

Add campaign

This flow step will create a new Mailchimp campaign.

Inputs

Label Type Required Default Visibility Description
Type dropDown yes - Always There are four types of campaigns you can create in Mailchimp.
List Id text yes - Always The unique list id.

Outputs

Name Type Description
response object Object resulting from the response to the endpoint call.

Add member to list

Add member of a specific Mailchimp list.

Inputs

Label Type Required Default Visibility Description
List Id text yes - Always The unique list id.
Email Address email yes - Always Email address for a subscriber.
Status dropDown yes - Always Subscriber's current status.
First Name text yes - Always First Name
Last Name text yes - Always Last Name

Outputs

Name Type Description
response object Object resulting from the response to the endpoint call.

Get campaign info

Get information about a specific campaign.

Inputs

Label Type Required Default Visibility Description
Campaign Id text yes - Always The unique id for the campaign.

Outputs

Name Type Description
response object Object resulting from the response to the endpoint call.

List campaigns

Get all campaigns in an account.

Outputs

Name Type Description
response object Object resulting from the response to the endpoint call.

Get lists info

Get information about all lists in the account.

Inputs

Label Type Required Default Visibility Description
Campaign Id text yes - Always The unique id for the campaign.

Outputs

Name Type Description
response object Object resulting from the response to the endpoint call.

List members info

This flow step will get information about members in a specific Mailchimp list.

Inputs

Label Type Required Default Visibility Description
List Id text yes - Always The unique ID for the list.

Outputs

Name Type Description
response object Object resulting from the response to the endpoint call.

Additional Helpers

MANUALLY ADD THE DOCUMENTATION OF THESE HELPERS HERE...