Mailchimp | Composio Docs

Overview

SLUG

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

OAuth2

client_id

stringRequired

client_secret

stringRequired

oauth_redirect_uri

stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add

scopes

string

bearer_token

string

subdomain

stringDefaults to us21Required

Tools

Get campaign info

SLUG: MAILCHIMP_GET_CAMPAIGN_INFO

Get information about a specific campaign.

Action Parameters

campaign_id

stringRequired

exclude_fields

array

fields

array

include_resend_shortcut_eligibility

boolean

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get lists info

SLUG: MAILCHIMP_GET_LISTS_INFO

Get information about all lists in the account.

Action Parameters

before_campaign_last_sent

string

before_date_created

string

count

integerDefaults to 10

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

objectRequired

error

string

successful

booleanRequired

List campaigns

SLUG: MAILCHIMP_LIST_CAMPAIGNS

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

objectRequired

error

string

successful

booleanRequired

List recent activity

SLUG: MAILCHIMP_LIST_RECENT_ACTIVITY

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

objectRequired

error

string

successful

booleanRequired

Search members

SLUG: MAILCHIMP_SEARCH_MEMBERS

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

objectRequired

error

string

successful

booleanRequired

Send campaign

SLUG: MAILCHIMP_SEND_CAMPAIGN

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

objectRequired

error

string

successful

booleanRequired

Add automation

SLUG: MAILCHIMP_ADD_AUTOMATION

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

objectRequired

error

string

successful

booleanRequired

Add batch webhook

SLUG: MAILCHIMP_ADD_BATCH_WEBHOOK

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

objectRequired

error

string

successful

booleanRequired

Add campaign

SLUG: MAILCHIMP_ADD_CAMPAIGN

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

objectRequired

error

string

successful

booleanRequired

Add campaign feedback

SLUG: MAILCHIMP_ADD_CAMPAIGN_FEEDBACK

Add feedback on a specific campaign.

Action Parameters

block_id

integer

campaign_id

stringRequired

is_complete

boolean

message

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Add campaign folder

SLUG: MAILCHIMP_ADD_CAMPAIGN_FOLDER

Create a new campaign folder.

Action Parameters

name

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Add cart

SLUG: MAILCHIMP_ADD_CART

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

stringRequired

lines

arrayRequired

order_total

integerRequired

store_id

stringRequired

tax_total

integer

Action Response

data

objectRequired

error

string

successful

booleanRequired

Add cart line item

SLUG: MAILCHIMP_ADD_CART_LINE_ITEM

Add a new line item to an existing cart.

Action Parameters

cart_id

stringRequired

price

integerRequired

product_id

stringRequired

product_variant_id

stringRequired

quantity

integerRequired

store_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Add connected site

SLUG: MAILCHIMP_ADD_CONNECTED_SITE

Create a new mailchimp connected site.

Action Parameters

domain

stringRequired

foreign_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Add customer

SLUG: MAILCHIMP_ADD_CUSTOMER

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

stringRequired

last_name

string

opt_in_status

booleanRequired

store_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Add domain to account

SLUG: MAILCHIMP_ADD_DOMAIN_TO_ACCOUNT

Add a domain to the account.

Action Parameters

verification_email

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Add event

SLUG: MAILCHIMP_ADD_EVENT

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

objectRequired

error

string

successful

booleanRequired

Add export

SLUG: MAILCHIMP_ADD_EXPORT

Create a new account export in your mailchimp account.

Action Parameters

include_stages

arrayRequired

since_timestamp

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Add file

SLUG: MAILCHIMP_ADD_FILE

Upload a new image or file to the file manager.

Action Parameters

file_data

stringRequired

folder_id

integer

name

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Add folder

SLUG: MAILCHIMP_ADD_FOLDER

Create a new folder in the file manager.

Action Parameters

name

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired