Mailchimp

Learn how to use Mailchimp with Composio

Overview

Enum

MAILCHIMP

Description

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

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
string
dc
stringDefaults to us21Required

Actions

Create a new classic automation in your mailchimp account.

Action Parameters

recipients__list__id
string
recipients__store__id
string
settings__from__name
string
settings__reply__to
string
trigger__settings__workflow__type
string

Action Response

data
object
error
successful
boolean

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

Action Parameters

enabled
boolean
url
stringRequired

Action Response

data
object
error
successful
boolean

Create a new mailchimp campaign.

Action Parameters

content_type
string
recipients__list__id
string
recipients__segment__opts__conditions
array
recipients__segment__opts__match
string
recipients__segment__opts__saved__segment__id
integer
rss__opts__constrain__rss__img
boolean
rss__opts__feed__url
string
rss__opts__frequency
string
rss__opts__schedule__daily__send__friday
boolean
rss__opts__schedule__daily__send__monday
boolean
rss__opts__schedule__daily__send__saturday
boolean
rss__opts__schedule__daily__send__sunday
boolean
rss__opts__schedule__daily__send__thursday
boolean
rss__opts__schedule__daily__send__tuesday
boolean
rss__opts__schedule__daily__send__wednesday
boolean
rss__opts__schedule__hour
integer
rss__opts__schedule__monthly__send__date
integer
rss__opts__schedule__weekly__send__day
string
settings__authenticate
boolean
settings__auto__fb__post
array
settings__auto__footer
boolean
settings__auto__tweet
boolean
settings__fb__comments
boolean
settings__folder__id
string
settings__from__name
string
settings__inline__css
boolean
settings__preview__text
string
settings__reply__to
string
settings__subject__line
string
settings__template__id
integer
settings__title
string
settings__to__name
string
settings__use__conversation
boolean
social__card__description
string
social__card__image__url
string
social__card__title
string
tracking__capsule__notes
boolean
tracking__clicktale
string
tracking__ecomm360
boolean
tracking__goal__tracking
boolean
tracking__google__analytics
string
tracking__html__clicks
boolean
tracking__opens
boolean
tracking__salesforce__campaign
boolean
tracking__salesforce__notes
boolean
tracking__text__clicks
boolean
type
stringRequired
variate__settings__from__names
array
variate__settings__reply__to__addresses
array
variate__settings__send__times
array
variate__settings__subject__lines
array
variate__settings__test__size
integer
variate__settings__wait__time
integer
variate__settings__winner__criteria
string

Action Response

data
object
error
successful
boolean

Add feedback on a specific campaign.

Action Parameters

block_id
integer
campaign_id
stringRequired
is_complete
boolean
message
stringRequired

Action Response

data
object
error
successful
boolean

Create a new campaign folder.

Action Parameters

name
stringRequired

Action Response

data
object
error
successful
boolean

Add a new cart to a store.

Action Parameters

campaign_id
string
checkout_url
string
currency_code
stringRequired
customer__address__address1
string
customer__address__address2
string
customer__address__city
string
customer__address__country
string
customer__address__country__code
string
customer__address__postal__code
string
customer__address__province
string
customer__address__province__code
string
customer__company
string
customer__email__address
string
customer__first__name
string
customer__id
string
customer__last__name
string
customer__opt__in__status
boolean
id
stringRequired
lines
arrayRequired
order_total
integerRequired
store_id
stringRequired
tax_total
integer

Action Response

data
object
error
successful
boolean

Add a new line item to an existing cart.

Action Parameters

cart_id
stringRequired
id
stringRequired
price
integerRequired
product_id
stringRequired
product_variant_id
stringRequired
quantity
integerRequired
store_id
stringRequired

Action Response

data
object
error
successful
boolean

Create a new mailchimp connected site.

Action Parameters

domain
stringRequired
foreign_id
stringRequired

Action Response

data
object
error
successful
boolean

Add a new customer to a store.

Action Parameters

address__address1
string
address__address2
string
address__city
string
address__country
string
address__country__code
string
address__postal__code
string
address__province
string
address__province__code
string
company
string
email_address
stringRequired
first_name
string
id
stringRequired
last_name
string
opt_in_status
booleanRequired
store_id
stringRequired

Action Response

data
object
error
successful
boolean

Add a domain to the account.

Action Parameters

verification_email
stringRequired

Action Response

data
object
error
successful
boolean

Add an event for a list member.

Action Parameters

is_syncing
boolean
list_id
stringRequired
name
stringRequired
occurred_at
string
properties
object
subscriber_hash
stringRequired

Action Response

data
object
error
successful
boolean

Create a new account export in your mailchimp account.

Action Parameters

include_stages
arrayRequired
since_timestamp
string

Action Response

data
object
error
successful
boolean

Upload a new image or file to the file manager.

Action Parameters

file_data
stringRequired
folder_id
integer
name
stringRequired

Action Response

data
object
error
successful
boolean

Create a new folder in the file manager.

Action Parameters

name
stringRequired

Action Response

data
object
error
successful
boolean

Create a new interest category.

Action Parameters

display_order
integer
list_id
stringRequired
title
stringRequired
type
stringRequired

Action Response

data
object
error
successful
boolean

Create a new interest or ‘group name’ for a specific category.

Action Parameters

display_order
integer
interest_category_id
stringRequired
list_id
stringRequired
name
stringRequired

Action Response

data
object
error
successful
boolean

Create a new mailchimp landing page.

Action Parameters

description
string
list_id
string
name
string
store_id
string
template_id
integer
title
string
tracking__enable__restricted__data__processing
boolean
tracking__track__with__mailchimp
boolean
type
string
use_default_list
boolean

Action Response

data
object
error
successful
boolean

Create a new list in your mailchimp account.

Action Parameters

campaign__defaults__from__email
string
campaign__defaults__from__name
string
campaign__defaults__language
string
campaign__defaults__subject
string
contact__address1
string
contact__address2
string
contact__city
string
contact__company
string
contact__country
string
contact__phone
string
contact__state
string
contact__zip
string
double_optin
boolean
email_type_option
booleanRequired
marketing_permissions
boolean
name
stringRequired
notify_on_subscribe
stringDefaults to False
notify_on_unsubscribe
stringDefaults to False
permission_reminder
stringRequired
use_archive_bar
boolean

Action Response

data
object
error
successful
boolean

Add a new note for a specific subscriber.

Action Parameters

list_id
stringRequired
note
string
subscriber_hash
stringRequired

Action Response

data
object
error
successful
boolean

Add a new member to the list.

Action Parameters

email_address
stringRequired
email_type
string
interests
object
ip_opt
string
ip_signup
string
language
string
list_id
stringRequired
location__latitude
integer
location__longitude
integer
marketing_permissions
array
merge_fields
object
skip_merge_validation
boolean
status
stringRequired
tags
array
timestamp_opt
string
timestamp_signup
string
vip
boolean

Action Response

data
object
error
successful
boolean

Add a member to a static segment.

Action Parameters

email_address
stringRequired
list_id
stringRequired
segment_id
stringRequired

Action Response

data
object
error
successful
boolean

Add a new merge field for a specific audience.

Action Parameters

default_value
string
display_order
integer
help_text
string
list_id
stringRequired
name
stringRequired
options__choices
array
options__date__format
string
options__default__country
integer
options__phone__format
string
options__size
integer
public
boolean
required
boolean
tag
string
type
stringRequired

Action Response

data
object
error
successful
boolean

Add a new order to a store.

Action Parameters

billing__address__address1
string
billing__address__address2
string
billing__address__city
string
billing__address__company
string
billing__address__country
string
billing__address__country__code
string
billing__address__latitude
integer
billing__address__longitude
integer
billing__address__name
string
billing__address__phone
string
billing__address__postal__code
string
billing__address__province
string
billing__address__province__code
string
campaign_id
string
cancelled_at_foreign
string
currency_code
stringRequired
customer__address__address1
string
customer__address__address2
string
customer__address__city
string
customer__address__country
string
customer__address__country__code
string
customer__address__postal__code
string
customer__address__province
string
customer__address__province__code
string
customer__company
string
customer__email__address
string
customer__first__name
string
customer__id
string
customer__last__name
string
customer__opt__in__status
boolean
discount_total
integer
financial_status
string
fulfillment_status
string
id
stringRequired
landing_site
string
lines
arrayRequired
order_total
integerRequired
order_url
string
outreach__id
string
processed_at_foreign
string
promos
array
shipping__address__address1
string
shipping__address__address2
string
shipping__address__city
string
shipping__address__company
string
shipping__address__country
string
shipping__address__country__code
string
shipping__address__latitude
integer
shipping__address__longitude
integer
shipping__address__name
string
shipping__address__phone
string
shipping__address__postal__code
string
shipping__address__province
string
shipping__address__province__code
string
shipping_total
integer
store_id
stringRequired
tax_total
integer
tracking_carrier
string
tracking_code
string
tracking_number
string
tracking_url
string
updated_at_foreign
string

Action Response

data
object
error
successful
boolean

Add a new line item to an existing order.

Action Parameters

discount
integer
id
stringRequired
order_id
stringRequired
price
integerRequired
product_id
stringRequired
product_variant_id
stringRequired
quantity
integerRequired
store_id
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

is_syncing
boolean
list_id
stringRequired
subscriber_hash
stringRequired
tags
arrayRequired

Action Response

data
object
error
successful
boolean

Add or update a customer.

Action Parameters

address__address1
string
address__address2
string
address__city
string
address__country
string
address__country__code
string
address__postal__code
string
address__province
string
address__province__code
string
company
string
customer_id
stringRequired
email_address
stringRequired
first_name
string
id
stringRequired
last_name
string
opt_in_status
booleanRequired
store_id
stringRequired

Action Response

data
object
error
successful
boolean

Add or update a list member.

Action Parameters

email_address
stringRequired
email_type
string
interests
object
ip_opt
string
ip_signup
string
language
string
list_id
stringRequired
location__latitude
integer
location__longitude
integer
marketing_permissions
array
merge_fields
object
skip_merge_validation
boolean
status
string
status_if_new
stringRequired
subscriber_hash
stringRequired
timestamp_opt
string
timestamp_signup
string
vip
boolean

Action Response

data
object
error
successful
boolean

Add or update a product variant.

Action Parameters

backorders
string
id
stringRequired
image_url
string
inventory_quantity
integer
price
integer
product_id
stringRequired
sku
string
store_id
stringRequired
title
stringRequired
url
string
variant_id
stringRequired
visibility
string

Action Response

data
object
error
successful
boolean

Add a new product to a store.

Action Parameters

description
string
handle
string
id
stringRequired
image_url
string
images
array
published_at_foreign
string
store_id
stringRequired
title
stringRequired
type
string
url
string
variants
arrayRequired
vendor
string

Action Response

data
object
error
successful
boolean

Add a new image to the product.

Action Parameters

id
stringRequired
product_id
stringRequired
store_id
stringRequired
url
stringRequired
variant_ids
array

Action Response

data
object
error
successful
boolean

Add a new variant to the product.

Action Parameters

backorders
string
id
stringRequired
image_url
string
inventory_quantity
integer
price
integer
product_id
stringRequired
sku
string
store_id
stringRequired
title
stringRequired
url
string
visibility
string

Action Response

data
object
error
successful
boolean

Add a new promo code to a store.

Action Parameters

code
stringRequired
created_at_foreign
string
enabled
boolean
id
stringRequired
promo_rule_id
stringRequired
redemption_url
stringRequired
store_id
stringRequired
updated_at_foreign
string
usage_count
integer

Action Response

data
object
error
successful
boolean

Add a new promo rule to a store.

Action Parameters

amount
integerRequired
created_at_foreign
string
description
stringRequired
enabled
boolean
ends_at
string
id
stringRequired
starts_at
string
store_id
stringRequired
target
stringRequired
title
string
type
stringRequired
updated_at_foreign
string

Action Response

data
object
error
successful
boolean

Create a new segment in a specific list.

Action Parameters

list_id
stringRequired
name
stringRequired
options__conditions
array
options__match
string
static_segment
array

Action Response

data
object
error
successful
boolean

Add a new store to your mailchimp account.

Action Parameters

address__address1
string
address__address2
string
address__city
string
address__country
string
address__country__code
string
address__latitude
integer
address__longitude
integer
address__postal__code
string
address__province
string
address__province__code
string
currency_code
stringRequired
domain
string
email_address
string
id
stringRequired
is_syncing
boolean
list_id
stringRequired
money_format
string
name
stringRequired
phone
string
platform
string
primary_locale
string
timezone
string

Action Response

data
object
error
successful
boolean

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.

Action Parameters

email_address
stringRequired
workflow_email_id
stringRequired
workflow_id
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

folder_id
string
html
stringRequired
name
stringRequired

Action Response

data
object
error
successful
boolean

Create a new template folder.

Action Parameters

name
stringRequired

Action Response

data
object
error
successful
boolean

Create a new webhook for a specific list.

Action Parameters

events__campaign
boolean
events__cleaned
boolean
events__profile
boolean
events__subscribe
boolean
events__unsubscribe
boolean
events__upemail
boolean
list_id
stringRequired
sources__admin
boolean
sources__api
boolean
sources__user
boolean
url
string

Action Response

data
object
error
successful
boolean

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

Action Parameters

workflow_id
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

list_id
stringRequired
subscriber_hash
stringRequired

Action Response

data
object
error
successful
boolean

Batch add/remove list members to static segment

Action Parameters

list_id
stringRequired
members_to_add
array
members_to_remove
array
segment_id
stringRequired

Action Response

data
object
error
successful
boolean

Batch subscribe or unsubscribe list members.

Action Parameters

list_id
stringRequired
members
arrayRequired
skip_duplicate_check
boolean
skip_merge_validation
boolean
sync_tags
boolean
update_existing
boolean

Action Response

data
object
error
successful
boolean

Get information about a specific abuse report for a campaign.

Action Parameters

campaign_id
stringRequired
exclude_fields
array
fields
array
report_id
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

campaign_id
stringRequired
exclude_fields
array
fields
array

Action Response

data
object
error
successful
boolean

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

Action Parameters

campaign_id
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

list_id
stringRequired
survey_id
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

email_address
stringRequired
journey_id
integerRequired
step_id
integerRequired

Action Response

data
object
error
successful
boolean

Customize a list’s default signup form.

Action Parameters

contents
array
header__image__align
string
header__image__alt
string
header__image__border__color
string
header__image__border__style
string
header__image__border__width
string
header__image__height
string
header__image__link
string
header__image__target
string
header__image__url
string
header__image__width
string
header__text
string
list_id
stringRequired
styles
array

Action Response

data
object
error
successful
boolean

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.

Action Parameters

batch_id
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

batch_webhook_id
stringRequired

Action Response

data
object
error
successful
boolean

Remove a campaign from your mailchimp account.

Action Parameters

campaign_id
stringRequired

Action Response

data
object
error
successful
boolean

Remove a specific feedback message for a campaign.

Action Parameters

campaign_id
stringRequired
feedback_id
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

folder_id
stringRequired

Action Response

data
object
error
successful
boolean

Delete a cart.

Action Parameters

cart_id
stringRequired
store_id
stringRequired

Action Response

data
object
error
successful
boolean

Delete a specific cart line item.

Action Parameters

cart_id
stringRequired
line_id
stringRequired
store_id
stringRequired

Action Response

data
object
error
successful
boolean

Remove a connected site from your mailchimp account.

Action Parameters

connected_site_id
stringRequired

Action Response

data
object
error
successful
boolean

Delete a customer from a store.

Action Parameters

customer_id
stringRequired
store_id
stringRequired

Action Response

data
object
error
successful
boolean

Delete a verified domain from the account.

Action Parameters

domain_name
stringRequired

Action Response

data
object
error
successful
boolean

Remove a specific file from the file manager.

Action Parameters

file_id
stringRequired

Action Response

data
object
error
successful
boolean

Delete a specific folder in the file manager.

Action Parameters

folder_id
stringRequired

Action Response

data
object
error
successful
boolean

Delete a specific interest category.

Action Parameters

interest_category_id
stringRequired
list_id
stringRequired

Action Response

data
object
error
successful
boolean

Delete interests or group names in a specific category.

Action Parameters

interest_category_id
stringRequired
interest_id
stringRequired
list_id
stringRequired

Action Response

data
object
error
successful
boolean

Delete a landing page.

Action Parameters

page_id
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

list_id
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

list_id
stringRequired
subscriber_hash
stringRequired

Action Response

data
object
error
successful
boolean

Delete a specific merge field.

Action Parameters

list_id
stringRequired
merge_id
stringRequired

Action Response

data
object
error
successful
boolean

Delete a specific note for a specific list member.

Action Parameters

list_id
stringRequired
note_id
stringRequired
subscriber_hash
stringRequired

Action Response

data
object
error
successful
boolean

Delete an order.

Action Parameters

order_id
stringRequired
store_id
stringRequired

Action Response

data
object
error
successful
boolean

Delete a specific order line item.

Action Parameters

line_id
stringRequired
order_id
stringRequired
store_id
stringRequired

Action Response

data
object
error
successful
boolean

Delete a product.

Action Parameters

product_id
stringRequired
store_id
stringRequired

Action Response

data
object
error
successful
boolean

Delete a product image.

Action Parameters

image_id
stringRequired
product_id
stringRequired
store_id
stringRequired

Action Response

data
object
error
successful
boolean

Delete a product variant.

Action Parameters

product_id
stringRequired
store_id
stringRequired
variant_id
stringRequired

Action Response

data
object
error
successful
boolean

Delete a promo code from a store.

Action Parameters

promo_code_id
stringRequired
promo_rule_id
stringRequired
store_id
stringRequired

Action Response

data
object
error
successful
boolean

Delete a promo rule from a store.

Action Parameters

promo_rule_id
stringRequired
store_id
stringRequired

Action Response

data
object
error
successful
boolean

Delete a specific segment in a list.

Action Parameters

list_id
stringRequired
segment_id
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

store_id
stringRequired

Action Response

data
object
error
successful
boolean

Delete a specific template.

Action Parameters

template_id
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

folder_id
stringRequired

Action Response

data
object
error
successful
boolean

Delete a specific webhook in a list.

Action Parameters

list_id
stringRequired
webhook_id
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

workflow_email_id
stringRequired
workflow_id
stringRequired

Action Response

data
object
error
successful
boolean

Get details about a specific abuse report.

Action Parameters

count
integerDefaults to 10
exclude_fields
array
fields
array
list_id
stringRequired
offset
integer
report_id
stringRequired

Action Response

data
object
error
successful
boolean

Get information about a specific account export.

Action Parameters

exclude_fields
array
export_id
stringRequired
fields
array

Action Response

data
object
error
successful
boolean

Get information about a specific authorized application.

Action Parameters

app_id
stringRequired
exclude_fields
array
fields
array

Action Response

data
object
error
successful
boolean

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

Action Parameters

subscriber_hash
stringRequired
workflow_email_id
stringRequired
workflow_id
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

exclude_fields
array
fields
array
workflow_id
stringRequired

Action Response

data
object
error
successful
boolean

Get the status of a batch request.

Action Parameters

batch_id
stringRequired
exclude_fields
array
fields
array

Action Response

data
object
error
successful
boolean

Get information about a specific batch webhook.

Action Parameters

batch_webhook_id
stringRequired
exclude_fields
array
fields
array

Action Response

data
object
error
successful
boolean

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

Action Parameters

campaign_id
stringRequired
exclude_fields
array
fields
array

Action Response

data
object
error
successful
boolean

Get a specific feedback message from a campaign.

Action Parameters

campaign_id
stringRequired
exclude_fields
array
feedback_id
stringRequired
fields
array

Action Response

data
object
error
successful
boolean

Get information about a specific folder used to organize campaigns.

Action Parameters

exclude_fields
array
fields
array
folder_id
stringRequired

Action Response

data
object
error
successful
boolean

Get information about a specific campaign.

Action Parameters

campaign_id
stringRequired
exclude_fields
array
fields
array
include_resend_shortcut_eligibility
boolean

Action Response

data
object
error
successful
boolean

Get information about a specific campaign recipient.

Action Parameters

campaign_id
stringRequired
exclude_fields
array
fields
array
subscriber_hash
stringRequired

Action Response

data
object
error
successful
boolean

Get report details for a specific sent campaign.

Action Parameters

campaign_id
stringRequired
exclude_fields
array
fields
array

Action Response

data
object
error
successful
boolean

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

Action Parameters

campaign_id
stringRequired
exclude_fields
array
fields
array

Action Response

data
object
error
successful
boolean

Get information about a specific cart.

Action Parameters

cart_id
stringRequired
exclude_fields
array
fields
array
store_id
stringRequired

Action Response

data
object
error
successful
boolean

Get information about a specific cart line item.

Action Parameters

cart_id
stringRequired
exclude_fields
array
fields
array
line_id
stringRequired
store_id
stringRequired

Action Response

data
object
error
successful
boolean

Get information about a specific connected site.

Action Parameters

connected_site_id
stringRequired
exclude_fields
array
fields
array

Action Response

data
object
error
successful
boolean

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

Action Parameters

conversation_id
stringRequired
exclude_fields
array
fields
array

Action Response

data
object
error
successful
boolean

Get information about a specific customer.

Action Parameters

customer_id
stringRequired
exclude_fields
array
fields
array
store_id
stringRequired

Action Response

data
object
error
successful
boolean

Get the details for a single domain on the account.

Action Parameters

domain_name
stringRequired

Action Response

data
object
error
successful
boolean

Get details of a facebook ad.

Action Parameters

exclude_fields
array
fields
array
outreach_id
stringRequired

Action Response

data
object
error
successful
boolean

Get report of a facebook ad.

Action Parameters

exclude_fields
array
fields
array
outreach_id
stringRequired

Action Response

data
object
error
successful
boolean

Get information about a specific file in the file manager.

Action Parameters

exclude_fields
array
fields
array
file_id
stringRequired

Action Response

data
object
error
successful
boolean

Get information about a specific folder in the file manager.

Action Parameters

exclude_fields
array
fields
array
folder_id
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

exclude_fields
array
fields
array
list_id
stringRequired
month
stringRequired

Action Response

data
object
error
successful
boolean

Get information about all available surveys for a specific list.

Action Parameters

list_id
stringRequired

Action Response

data
object
error
successful
boolean

Get information about a specific interest category.

Action Parameters

exclude_fields
array
fields
array
interest_category_id
stringRequired
list_id
stringRequired

Action Response

data
object
error
successful
boolean

Get interests or ‘group names’ for a specific category.

Action Parameters

exclude_fields
array
fields
array
interest_category_id
stringRequired
interest_id
stringRequired
list_id
stringRequired

Action Response

data
object
error
successful
boolean

Get the the html for your landing page.

Action Parameters

exclude_fields
array
fields
array
page_id
stringRequired

Action Response

data
object
error
successful
boolean

Get information about a specific page.

Action Parameters

exclude_fields
array
fields
array
page_id
stringRequired

Action Response

data
object
error
successful
boolean

Get report of a landing page.

Action Parameters

exclude_fields
array
fields
array
outreach_id
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

count
integerDefaults to 10
offset
integer

Action Response

data
object
error
successful
boolean

Get information about all lists in the account.

Action Parameters

before_campaign_last_sent
string
before_date_created
string
count
integerDefaults to 10
email
string
exclude_fields
array
fields
array
has_ecommerce_store
boolean
include_total_contacts
boolean
offset
integer
since_campaign_last_sent
string
since_date_created
string
sort_dir
string
sort_field
string

Action Response

data
object
error
successful
boolean

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

Action Parameters

exclude_fields
array
fields
array
include_total_contacts
boolean
list_id
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

exclude_fields
array
fields
array
list_id
stringRequired
subscriber_hash
stringRequired

Action Response

data
object
error
successful
boolean

Get a specific note for a specific list member.

Action Parameters

exclude_fields
array
fields
array
list_id
stringRequired
note_id
stringRequired
subscriber_hash
stringRequired

Action Response

data
object
error
successful
boolean

Get information about a specific merge field.

Action Parameters

exclude_fields
array
fields
array
list_id
stringRequired
merge_id
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

conversation_id
stringRequired
exclude_fields
array
fields
array
message_id
stringRequired

Action Response

data
object
error
successful
boolean

Get information about a specific subscriber who opened a campaign.

Action Parameters

campaign_id
stringRequired
exclude_fields
array
fields
array
subscriber_hash
stringRequired

Action Response

data
object
error
successful
boolean

Get information about a specific order.

Action Parameters

exclude_fields
array
fields
array
order_id
stringRequired
store_id
stringRequired

Action Response

data
object
error
successful
boolean

Get information about a specific order line item.

Action Parameters

exclude_fields
array
fields
array
line_id
stringRequired
order_id
stringRequired
store_id
stringRequired

Action Response

data
object
error
successful
boolean

Get information about a specific product image.

Action Parameters

exclude_fields
array
fields
array
image_id
stringRequired
product_id
stringRequired
store_id
stringRequired

Action Response

data
object
error
successful
boolean

Get information about a specific product.

Action Parameters

exclude_fields
array
fields
array
product_id
stringRequired
store_id
stringRequired

Action Response

data
object
error
successful
boolean

Get information about a specific product variant.

Action Parameters

exclude_fields
array
fields
array
product_id
stringRequired
store_id
stringRequired
variant_id
stringRequired

Action Response

data
object
error
successful
boolean

Get information about a specific promo code.

Action Parameters

exclude_fields
array
fields
array
promo_code_id
stringRequired
promo_rule_id
stringRequired
store_id
stringRequired

Action Response

data
object
error
successful
boolean

Get information about a specific promo rule.

Action Parameters

exclude_fields
array
fields
array
promo_rule_id
stringRequired
store_id
stringRequired

Action Response

data
object
error
successful
boolean

Get information about a specific segment.

Action Parameters

exclude_fields
array
fields
array
include_cleaned
boolean
include_transactional
boolean
include_unsubscribed
boolean
list_id
stringRequired
segment_id
stringRequired

Action Response

data
object
error
successful
boolean

Get information about a specific store.

Action Parameters

exclude_fields
array
fields
array
store_id
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

campaign_id
stringRequired
exclude_fields
array
fields
array
since
string
subscriber_hash
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

subscriber_hash
stringRequired
workflow_id
stringRequired

Action Response

data
object
error
successful
boolean

Get details about a specific survey.

Action Parameters

list_id
stringRequired
survey_id
stringRequired

Action Response

data
object
error
successful
boolean

Get report for a survey question.

Action Parameters

exclude_fields
array
fields
array
question_id
stringRequired
survey_id
stringRequired

Action Response

data
object
error
successful
boolean

Get report for a survey.

Action Parameters

exclude_fields
array
fields
array
survey_id
stringRequired

Action Response

data
object
error
successful
boolean

Get a single survey response.

Action Parameters

response_id
stringRequired
survey_id
stringRequired

Action Response

data
object
error
successful
boolean

Get information about a specific folder used to organize templates.

Action Parameters

exclude_fields
array
fields
array
folder_id
stringRequired

Action Response

data
object
error
successful
boolean

Get information about a specific template.

Action Parameters

exclude_fields
array
fields
array
template_id
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

campaign_id
stringRequired
exclude_fields
array
fields
array
subscriber_hash
stringRequired

Action Response

data
object
error
successful
boolean

Get information about a specific webhook.

Action Parameters

list_id
stringRequired
webhook_id
stringRequired

Action Response

data
object
error
successful
boolean

Get information about an individual classic automation workflow email.

Action Parameters

workflow_email_id
stringRequired
workflow_id
stringRequired

Action Response

data
object
error
successful
boolean

Get all abuse reports for a specific list.

Action Parameters

count
integerDefaults to 10
exclude_fields
array
fields
array
list_id
stringRequired
offset
integer

Action Response

data
object
error
successful
boolean

Get a list of account exports for a given account.

Action Parameters

count
integerDefaults to 10
exclude_fields
array
fields
array
offset
integer

Action Response

data
object
error
successful
boolean

Get information about an account’s orders.

Action Parameters

campaign_id
string
count
integerDefaults to 10
customer_id
string
exclude_fields
array
fields
array
has_outreach
boolean
offset
integer
outreach_id
string

Action Response

data
object
error
successful
boolean

Get answers for a survey question.

Action Parameters

exclude_fields
array
fields
array
question_id
stringRequired
respondent_familiarity_is
string
survey_id
stringRequired

Action Response

data
object
error
successful
boolean

Get links to all other resources available in the api.

Action Parameters

exclude_fields
array
fields
array

Action Response

data
object
error
successful
boolean

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

Action Parameters

count
integerDefaults to 10
exclude_fields
array
fields
array
offset
integer

Action Response

data
object
error
successful
boolean

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

Action Parameters

workflow_id
stringRequired

Action Response

data
object
error
successful
boolean

Get information about a classic automation email queue.

Action Parameters

workflow_email_id
stringRequired
workflow_id
stringRequired

Action Response

data
object
error
successful
boolean

Get a summary of an account’s classic automations.

Action Parameters

before_create_time
string
before_start_time
string
count
integerDefaults to 10
exclude_fields
array
fields
array
offset
integer
since_create_time
string
since_start_time
string
status
string

Action Response

data
object
error
successful
boolean

Get a summary of batch requests that have been made.

Action Parameters

count
integerDefaults to 10
exclude_fields
array
fields
array
offset
integer

Action Response

data
object
error
successful
boolean

Get all webhooks that have been configured for batches.

Action Parameters

count
integerDefaults to 10
exclude_fields
array
fields
array
offset
integer

Action Response

data
object
error
successful
boolean

Get all campaigns in an account.

Action Parameters

before_create_time
string
before_send_time
string
count
integerDefaults to 10
exclude_fields
array
fields
array
folder_id
string
include_resend_shortcut_eligibility
boolean
list_id
string
member_id
string
offset
integer
since_create_time
string
since_send_time
string
sort_dir
string
sort_field
string
status
string
type
string

Action Response

data
object
error
successful
boolean

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

Action Parameters

campaign_id
stringRequired
count
integerDefaults to 10
exclude_fields
array
fields
array
offset
integer
sort_dir
string
sort_field
string

Action Response

data
object
error
successful
boolean

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

Action Parameters

campaign_id
stringRequired
exclude_fields
array
fields
array

Action Response

data
object
error
successful
boolean

Get all folders used to organize campaigns.

Action Parameters

count
integerDefaults to 10
exclude_fields
array
fields
array
offset
integer

Action Response

data
object
error
successful
boolean

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

Action Parameters

campaign_id
stringRequired
count
integerDefaults to 10
exclude_fields
array
fields
array
offset
integer
since
string
sort_dir
string
sort_field
string

Action Response

data
object
error
successful
boolean

Get breakdown of product activity for a campaign

Action Parameters

campaign_id
stringRequired
count
integerDefaults to 10
exclude_fields
array
fields
array
offset
integer
sort_field
string

Action Response

data
object
error
successful
boolean

Get information about campaign recipients.

Action Parameters

campaign_id
stringRequired
count
integerDefaults to 10
exclude_fields
array
fields
array
offset
integer

Action Response

data
object
error
successful
boolean

Get campaign reports.

Action Parameters

before_send_time
string
count
integerDefaults to 10
exclude_fields
array
fields
array
offset
integer
since_send_time
string
type
string

Action Response

data
object
error
successful
boolean

Get information about a store’s carts.

Action Parameters

count
integerDefaults to 10
exclude_fields
array
fields
array
offset
integer
store_id
stringRequired

Action Response

data
object
error
successful
boolean

Get information about a cart’s line items.

Action Parameters

cart_id
stringRequired
count
integerDefaults to 10
exclude_fields
array
fields
array
offset
integer
store_id
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

campaign_id
stringRequired
exclude_fields
array
fields
array

Action Response

data
object
error
successful
boolean

Get all connected sites in an account.

Action Parameters

count
integerDefaults to 10
exclude_fields
array
fields
array
offset
integer

Action Response

data
object
error
successful
boolean

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

Action Parameters

campaign_id
string
count
integerDefaults to 10
exclude_fields
array
fields
array
has_unread_messages
string
list_id
string
offset
integer

Action Response

data
object
error
successful
boolean

Get information about a store’s customers.

Action Parameters

count
integerDefaults to 10
email_address
string
exclude_fields
array
fields
array
offset
integer
store_id
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

campaign_id
stringRequired
exclude_fields
array
fields
array

Action Response

data
object
error
successful
boolean

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

Action Parameters

campaign_id
stringRequired
exclude_fields
array
fields
array

Action Response

data
object
error
successful
boolean

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

Action Parameters

campaign_id
stringRequired
count
integerDefaults to 10
exclude_fields
array
fields
array
offset
integer
since
string

Action Response

data
object
error
successful
boolean

Get list of facebook ads.

Action Parameters

count
integerDefaults to 10
exclude_fields
array
fields
array
offset
integer
sort_dir
string
sort_field
string

Action Response

data
object
error
successful
boolean

Get reports of facebook ads.

Action Parameters

count
integerDefaults to 10
exclude_fields
array
fields
array
offset
integer
sort_dir
string
sort_field
string

Action Response

data
object
error
successful
boolean

Get breakdown of product activity for an outreach.

Action Parameters

count
integerDefaults to 10
exclude_fields
array
fields
array
offset
integer
outreach_id
stringRequired
sort_field
string

Action Response

data
object
error
successful
boolean

Get a list of all folders in the file manager.

Action Parameters

before_created_at
string
count
integerDefaults to 10
created_by
string
exclude_fields
array
fields
array
offset
integer
since_created_at
string

Action Response

data
object
error
successful
boolean

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

Action Parameters

count
integerDefaults to 10
exclude_fields
array
fields
array
list_id
stringRequired
offset
integer
sort_dir
string
sort_field
string

Action Response

data
object
error
successful
boolean

Get a list of this category’s interests.

Action Parameters

count
integerDefaults to 10
exclude_fields
array
fields
array
interest_category_id
stringRequired
list_id
stringRequired
offset
integer

Action Response

data
object
error
successful
boolean

Get information about a list’s interest categories.

Action Parameters

count
integerDefaults to 10
exclude_fields
array
fields
array
list_id
stringRequired
offset
integer
type
string

Action Response

data
object
error
successful
boolean

Get all landing pages.

Action Parameters

count
integerDefaults to 10
exclude_fields
array
fields
array
sort_dir
string
sort_field
string

Action Response

data
object
error
successful
boolean

Get reports of landing pages.

Action Parameters

count
integerDefaults to 10
exclude_fields
array
fields
array
offset
integer

Action Response

data
object
error
successful
boolean

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

Action Parameters

exclude_fields
array
fields
array
list_id
stringRequired

Action Response

data
object
error
successful
boolean

Get information about members in a specific mailchimp list.

Action Parameters

before_last_changed
string
before_timestamp_opt
string
count
integerDefaults to 10
email_type
string
exclude_fields
array
fields
array
interest_category_id
string
interest_ids
string
interest_match
string
list_id
stringRequired
offset
integer
since_last_campaign
boolean
since_last_changed
string
since_timestamp_opt
string
sort_dir
string
sort_field
string
status
string
unique_email_id
string
unsubscribed_since
string
vip_only
boolean

Action Response

data
object
error
successful
boolean

Get information about members in a saved segment.

Action Parameters

count
integerDefaults to 10
exclude_fields
array
fields
array
include_cleaned
boolean
include_transactional
boolean
include_unsubscribed
boolean
list_id
stringRequired
offset
integer
segment_id
stringRequired

Action Response

data
object
error
successful
boolean

Get events for a contact.

Action Parameters

count
integerDefaults to 10
exclude_fields
array
fields
array
list_id
stringRequired
offset
integer
subscriber_hash
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

exclude_fields
array
fields
array
list_id
stringRequired
subscriber_hash
stringRequired

Action Response

data
object
error
successful
boolean

Get the tags on a list member.

Action Parameters

count
integerDefaults to 10
exclude_fields
array
fields
array
list_id
stringRequired
offset
integer
subscriber_hash
stringRequired

Action Response

data
object
error
successful
boolean

Get a list of all merge fields for an audience.

Action Parameters

count
integerDefaults to 10
exclude_fields
array
fields
array
list_id
stringRequired
offset
integer
required
boolean
type
string

Action Response

data
object
error
successful
boolean

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

Action Parameters

before_timestamp
string
conversation_id
stringRequired
exclude_fields
array
fields
array
is_read
string
since_timestamp
string

Action Response

data
object
error
successful
boolean

Get information about a store’s orders.

Action Parameters

campaign_id
string
count
integerDefaults to 10
customer_id
string
exclude_fields
array
fields
array
has_outreach
boolean
offset
integer
outreach_id
string
store_id
stringRequired

Action Response

data
object
error
successful
boolean

Get information about an order’s line items.

Action Parameters

count
integerDefaults to 10
exclude_fields
array
fields
array
offset
integer
order_id
stringRequired
store_id
stringRequired

Action Response

data
object
error
successful
boolean

Get information about a store’s products.

Action Parameters

count
integerDefaults to 10
exclude_fields
array
fields
array
offset
integer
store_id
stringRequired

Action Response

data
object
error
successful
boolean

Get information about a product’s images.

Action Parameters

count
integerDefaults to 10
exclude_fields
array
fields
array
offset
integer
product_id
stringRequired
store_id
stringRequired

Action Response

data
object
error
successful
boolean

Get information about a product’s variants.

Action Parameters

count
integerDefaults to 10
exclude_fields
array
fields
array
offset
integer
product_id
stringRequired
store_id
stringRequired

Action Response

data
object
error
successful
boolean

Get information about a store’s promo codes.

Action Parameters

count
integerDefaults to 10
exclude_fields
array
fields
array
offset
integer
promo_rule_id
stringRequired
store_id
stringRequired

Action Response

data
object
error
successful
boolean

Get information about a store’s promo rules.

Action Parameters

count
integerDefaults to 10
exclude_fields
array
fields
array
offset
integer
store_id
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

count
integerDefaults to 10
exclude_fields
array
fields
array
list_id
stringRequired
offset
integer

Action Response

data
object
error
successful
boolean

Get recent notes for a specific list member.

Action Parameters

count
integerDefaults to 10
exclude_fields
array
fields
array
list_id
stringRequired
offset
integer
sort_dir
string
sort_field
string
subscriber_hash
stringRequired

Action Response

data
object
error
successful
boolean

Get information about all available segments for a specific list.

Action Parameters

before_created_at
string
before_updated_at
string
count
integerDefaults to 10
exclude_fields
array
fields
array
include_cleaned
boolean
include_transactional
boolean
include_unsubscribed
boolean
list_id
stringRequired
offset
integer
since_created_at
string
since_updated_at
string
type
string

Action Response

data
object
error
successful
boolean

Get all of the sending domains on the account.

Action Parameters

Action Response

data
object
error
successful
boolean

Get signup forms for a specific list.

Action Parameters

list_id
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

before_created_at
string
count
integerDefaults to 10
created_by
string
exclude_fields
array
fields
array
offset
integer
since_created_at
string
sort_dir
string
sort_field
string
type
string

Action Response

data
object
error
successful
boolean

Get information about all stores in the account.

Action Parameters

count
integerDefaults to 10
exclude_fields
array
fields
array
offset
integer

Action Response

data
object
error
successful
boolean

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

Action Parameters

workflow_id
stringRequired

Action Response

data
object
error
successful
boolean

Get reports for survey questions.

Action Parameters

exclude_fields
array
fields
array
survey_id
stringRequired

Action Response

data
object
error
successful
boolean

Get reports for surveys.

Action Parameters

count
integerDefaults to 10
exclude_fields
array
fields
array
offset
integer

Action Response

data
object
error
successful
boolean

Get responses to a survey.

Action Parameters

answered_question
integer
chose_answer
string
exclude_fields
array
fields
array
respondent_familiarity_is
string
survey_id
stringRequired

Action Response

data
object
error
successful
boolean

Get a list of an account’s available templates.

Action Parameters

before_date_created
string
category
string
content_type
string
count
integerDefaults to 10
created_by
string
exclude_fields
array
fields
array
folder_id
string
offset
integer
since_date_created
string
sort_dir
string
sort_field
string
type
string

Action Response

data
object
error
successful
boolean

Get all folders used to organize templates.

Action Parameters

count
integerDefaults to 10
exclude_fields
array
fields
array
offset
integer

Action Response

data
object
error
successful
boolean

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

Action Parameters

exclude_fields
array
fields
array
list_id
stringRequired

Action Response

data
object
error
successful
boolean

Get top open locations for a specific campaign.

Action Parameters

campaign_id
stringRequired
count
integerDefaults to 10
exclude_fields
array
fields
array
offset
integer

Action Response

data
object
error
successful
boolean

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

Action Parameters

campaign_id
stringRequired
count
integerDefaults to 10
exclude_fields
array
fields
array
offset
integer

Action Response

data
object
error
successful
boolean

Get information about all webhooks for a specific list.

Action Parameters

list_id
stringRequired

Action Response

data
object
error
successful
boolean

Pause an automated email.

Action Parameters

workflow_email_id
stringRequired
workflow_id
stringRequired

Action Response

data
object
error
successful
boolean

Pause all emails in a specific classic automation workflow.

Action Parameters

workflow_id
stringRequired

Action Response

data
object
error
successful
boolean

Pause an rss-driven campaign.

Action Parameters

campaign_id
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

Action Response

data
object
error
successful
boolean

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

Action Parameters

list_id
stringRequired
survey_id
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

page_id
stringRequired

Action Response

data
object
error
successful
boolean

Remove a member from the specified static segment.

Action Parameters

list_id
stringRequired
segment_id
stringRequired
subscriber_hash
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

email_address
stringRequired
workflow_id
stringRequired

Action Response

data
object
error
successful
boolean

Replicate a campaign in saved or send status.

Action Parameters

campaign_id
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

campaign_id
stringRequired
shortcut_type
string

Action Response

data
object
error
successful
boolean

Resume an rss-driven campaign.

Action Parameters

campaign_id
stringRequired

Action Response

data
object
error
successful
boolean

Get a list of abuse complaints for a specific campaign.

Action Parameters

campaign_id
stringRequired
exclude_fields
array
fields
array

Action Response

data
object
error
successful
boolean

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

Action Parameters

before_created_at
string
count
integerDefaults to 10
created_by
string
exclude_fields
array
fields
array
folder_id
stringRequired
offset
integer
since_created_at
string
sort_dir
string
sort_field
string
type
string

Action Response

data
object
error
successful
boolean

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

Action Parameters

batch__delivery__batch__count
integer
batch__delivery__batch__delay
integer
campaign_id
stringRequired
schedule_time
stringRequired
timewarp
boolean

Action Response

data
object
error
successful
boolean

Search all campaigns for the specified query terms.

Action Parameters

exclude_fields
array
fields
array
query
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

list_id
stringRequired
name
string

Action Response

data
object
error
successful
boolean

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

Action Parameters

exclude_fields
array
fields
array
list_id
string
query
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

campaign_id
stringRequired

Action Response

data
object
error
successful
boolean

Send a test email.

Action Parameters

campaign_id
stringRequired
send_type
stringRequired
test_emails
arrayRequired

Action Response

data
object
error
successful
boolean

Set the content for a campaign.

Action Parameters

archive__archive__content
string
archive__archive__type
string
campaign_id
stringRequired
html
string
plain_text
string
template__id
integer
url
string
variate_contents
array

Action Response

data
object
error
successful
boolean

Start an automated email.

Action Parameters

workflow_email_id
stringRequired
workflow_id
stringRequired

Action Response

data
object
error
successful
boolean

Start all emails in a classic automation workflow.

Action Parameters

workflow_id
stringRequired

Action Response

data
object
error
successful
boolean

Begin processing a batch operations request.

Action Parameters

operations
arrayRequired

Action Response

data
object
error
successful
boolean

Unpublish a survey that has been published.

Action Parameters

list_id
stringRequired
survey_id
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

page_id
stringRequired

Action Response

data
object
error
successful
boolean

Unschedule a scheduled campaign that hasn’t started sending.

Action Parameters

campaign_id
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

batch_webhook_id
stringRequired
enabled
boolean
url
string

Action Response

data
object
error
successful
boolean

Update a specific feedback message for a campaign.

Action Parameters

block_id
integer
campaign_id
stringRequired
feedback_id
stringRequired
is_complete
boolean
message
string

Action Response

data
object
error
successful
boolean

Update a specific folder used to organize campaigns.

Action Parameters

folder_id
stringRequired
name
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

campaign_id
stringRequired
recipients__list__id
string
recipients__segment__opts__conditions
array
recipients__segment__opts__match
string
recipients__segment__opts__prebuilt__segment__id
string
recipients__segment__opts__saved__segment__id
integer
rss__opts__constrain__rss__img
boolean
rss__opts__feed__url
string
rss__opts__frequency
string
rss__opts__schedule__daily__send__friday
boolean
rss__opts__schedule__daily__send__monday
boolean
rss__opts__schedule__daily__send__saturday
boolean
rss__opts__schedule__daily__send__sunday
boolean
rss__opts__schedule__daily__send__thursday
boolean
rss__opts__schedule__daily__send__tuesday
boolean
rss__opts__schedule__daily__send__wednesday
boolean
rss__opts__schedule__hour
integer
rss__opts__schedule__monthly__send__date
integer
rss__opts__schedule__weekly__send__day
string
settings__authenticate
boolean
settings__auto__fb__post
array
settings__auto__footer
boolean
settings__auto__tweet
boolean
settings__fb__comments
boolean
settings__folder__id
string
settings__from__name
string
settings__inline__css
boolean
settings__preview__text
string
settings__reply__to
string
settings__subject__line
string
settings__template__id
integer
settings__title
string
settings__to__name
string
settings__use__conversation
boolean
social__card__description
string
social__card__image__url
string
social__card__title
string
tracking__capsule__notes
boolean
tracking__clicktale
string
tracking__ecomm360
boolean
tracking__goal__tracking
boolean
tracking__google__analytics
string
tracking__html__clicks
boolean
tracking__opens
boolean
tracking__salesforce__campaign
boolean
tracking__salesforce__notes
boolean
tracking__text__clicks
boolean
variate__settings__from__names
array
variate__settings__reply__to__addresses
array
variate__settings__send__times
array
variate__settings__subject__lines
array
variate__settings__test__size
integer
variate__settings__wait__time
integer
variate__settings__winner__criteria
string

Action Response

data
object
error
successful
boolean

Update a specific cart.

Action Parameters

campaign_id
string
cart_id
stringRequired
checkout_url
string
currency_code
string
customer__address__address1
string
customer__address__address2
string
customer__address__city
string
customer__address__country
string
customer__address__country__code
string
customer__address__postal__code
string
customer__address__province
string
customer__address__province__code
string
customer__company
string
customer__first__name
string
customer__last__name
string
customer__opt__in__status
boolean
lines
array
order_total
integer
store_id
stringRequired
tax_total
integer

Action Response

data
object
error
successful
boolean

Update a specific cart line item.

Action Parameters

cart_id
stringRequired
line_id
stringRequired
price
integer
product_id
string
product_variant_id
string
quantity
integer
store_id
stringRequired

Action Response

data
object
error
successful
boolean

Update a customer.

Action Parameters

address__address1
string
address__address2
string
address__city
string
address__country
string
address__country__code
string
address__postal__code
string
address__province
string
address__province__code
string
company
string
customer_id
stringRequired
first_name
string
last_name
string
opt_in_status
boolean
store_id
stringRequired

Action Response

data
object
error
successful
boolean

Update a file in the file manager.

Action Parameters

file_id
stringRequired
folder_id
integer
name
string

Action Response

data
object
error
successful
boolean

Update a specific file manager folder.

Action Parameters

folder_id
stringRequired
name
stringRequired

Action Response

data
object
error
successful
boolean

Update a specific interest category.

Action Parameters

display_order
integer
interest_category_id
stringRequired
list_id
stringRequired
title
stringRequired
type
stringRequired

Action Response

data
object
error
successful
boolean

Update interests or ‘group names’ for a specific category.

Action Parameters

display_order
integer
interest_category_id
stringRequired
interest_id
stringRequired
list_id
stringRequired
name
stringRequired

Action Response

data
object
error
successful
boolean

Update a landing page.

Action Parameters

description
string
list_id
string
name
string
page_id
stringRequired
store_id
string
title
string
tracking__enable__restricted__data__processing
boolean
tracking__track__with__mailchimp
boolean

Action Response

data
object
error
successful
boolean

Update the settings for a specific list.

Action Parameters

campaign__defaults__from__email
string
campaign__defaults__from__name
string
campaign__defaults__language
string
campaign__defaults__subject
string
contact__address1
string
contact__address2
string
contact__city
string
contact__company
string
contact__country
string
contact__phone
string
contact__state
string
contact__zip
string
double_optin
boolean
email_type_option
booleanRequired
list_id
stringRequired
marketing_permissions
boolean
name
stringRequired
notify_on_subscribe
stringDefaults to False
notify_on_unsubscribe
stringDefaults to False
permission_reminder
stringRequired
use_archive_bar
boolean

Action Response

data
object
error
successful
boolean

Update information for a specific list member.

Action Parameters

email_address
string
email_type
string
interests
object
ip_opt
string
ip_signup
string
language
string
list_id
stringRequired
location__latitude
integer
location__longitude
integer
marketing_permissions
array
merge_fields
object
skip_merge_validation
boolean
status
string
subscriber_hash
stringRequired
timestamp_opt
string
timestamp_signup
string
vip
boolean

Action Response

data
object
error
successful
boolean

Update a specific merge field.

Action Parameters

default_value
string
display_order
integer
help_text
string
list_id
stringRequired
merge_id
stringRequired
name
stringRequired
options__choices
array
options__date__format
string
options__default__country
integer
options__phone__format
string
public
boolean
required
boolean
tag
string

Action Response

data
object
error
successful
boolean

Update a specific note for a specific list member.

Action Parameters

list_id
stringRequired
note
string
note_id
stringRequired
subscriber_hash
stringRequired

Action Response

data
object
error
successful
boolean

Update a specific order.

Action Parameters

billing__address__address1
string
billing__address__address2
string
billing__address__city
string
billing__address__company
string
billing__address__country
string
billing__address__country__code
string
billing__address__latitude
integer
billing__address__longitude
integer
billing__address__name
string
billing__address__phone
string
billing__address__postal__code
string
billing__address__province
string
billing__address__province__code
string
campaign_id
string
cancelled_at_foreign
string
currency_code
string
customer__address__address1
string
customer__address__address2
string
customer__address__city
string
customer__address__country
string
customer__address__country__code
string
customer__address__postal__code
string
customer__address__province
string
customer__address__province__code
string
customer__company
string
customer__first__name
string
customer__last__name
string
customer__opt__in__status
boolean
discount_total
integer
financial_status
string
fulfillment_status
string
landing_site
string
lines
array
order_id
stringRequired
order_total
integer
order_url
string
outreach__id
string
processed_at_foreign
string
promos
array
shipping__address__address1
string
shipping__address__address2
string
shipping__address__city
string
shipping__address__company
string
shipping__address__country
string
shipping__address__country__code
string
shipping__address__latitude
integer
shipping__address__longitude
integer
shipping__address__name
string
shipping__address__phone
string
shipping__address__postal__code
string
shipping__address__province
string
shipping__address__province__code
string
shipping_total
integer
store_id
stringRequired
tax_total
integer
tracking_carrier
string
tracking_code
string
tracking_number
string
tracking_url
string
updated_at_foreign
string

Action Response

data
object
error
successful
boolean

Update a specific order line item.

Action Parameters

discount
integer
line_id
stringRequired
order_id
stringRequired
price
integer
product_id
string
product_variant_id
string
quantity
integer
store_id
stringRequired

Action Response

data
object
error
successful
boolean

Update a specific product.

Action Parameters

description
string
handle
string
image_url
string
images
array
product_id
stringRequired
published_at_foreign
string
store_id
stringRequired
title
string
type
string
url
string
variants
array
vendor
string

Action Response

data
object
error
successful
boolean

Update a product image.

Action Parameters

id
string
image_id
stringRequired
product_id
stringRequired
store_id
stringRequired
url
string
variant_ids
array

Action Response

data
object
error
successful
boolean

Update a product variant.

Action Parameters

backorders
string
image_url
string
inventory_quantity
integer
price
integer
product_id
stringRequired
sku
string
store_id
stringRequired
title
string
url
string
variant_id
stringRequired
visibility
string

Action Response

data
object
error
successful
boolean

Update a promo code.

Action Parameters

code
string
created_at_foreign
string
enabled
boolean
promo_code_id
stringRequired
promo_rule_id
stringRequired
redemption_url
string
store_id
stringRequired
updated_at_foreign
string
usage_count
integer

Action Response

data
object
error
successful
boolean

Update a promo rule.

Action Parameters

amount
integer
created_at_foreign
string
description
string
enabled
boolean
ends_at
string
promo_rule_id
stringRequired
starts_at
string
store_id
stringRequired
target
string
title
string
type
string
updated_at_foreign
string

Action Response

data
object
error
successful
boolean

Update a store.

Action Parameters

address__address1
string
address__address2
string
address__city
string
address__country
string
address__country__code
string
address__latitude
integer
address__longitude
integer
address__postal__code
string
address__province
string
address__province__code
string
currency_code
string
domain
string
email_address
string
is_syncing
boolean
money_format
string
name
string
phone
string
platform
string
primary_locale
string
store_id
stringRequired
timezone
string

Action Response

data
object
error
successful
boolean

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

Action Parameters

folder_id
string
html
stringRequired
name
stringRequired
template_id
stringRequired

Action Response

data
object
error
successful
boolean

Update a specific folder used to organize templates.

Action Parameters

folder_id
stringRequired
name
stringRequired

Action Response

data
object
error
successful
boolean

Update the settings for an existing webhook.

Action Parameters

events__campaign
boolean
events__cleaned
boolean
events__profile
boolean
events__subscribe
boolean
events__unsubscribe
boolean
events__upemail
boolean
list_id
stringRequired
sources__admin
boolean
sources__api
boolean
sources__user
boolean
url
string
webhook_id
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

delay__action
string
delay__amount
integer
delay__direction
string
delay__type
string
settings__from__name
string
settings__preview__text
string
settings__reply__to
string
settings__subject__line
string
settings__title
string
workflow_email_id
stringRequired
workflow_id
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

connected_site_id
stringRequired

Action Response

data
object
error
successful
boolean

Verify a domain for sending.

Action Parameters

code
stringRequired
domain_name
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

exclude_fields
array
fields
array
template_id
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

activity_filters
array
count
integerDefaults to 10
exclude_fields
array
fields
array
list_id
stringRequired
offset
integer
subscriber_hash
stringRequired

Action Response

data
object
error
successful
boolean

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

Action Parameters

action
array
exclude_fields
array
fields
array
list_id
stringRequired
subscriber_hash
stringRequired

Action Response

data
object
error
successful
boolean