Skip to main content

Mailchimp Component

Interact with email campaign lists and e-commerce resources.

Component key: mailchimp

Description#

Mailchimp is a marketing automation platform and email marketing service. The Mailchimp component allows you to interact with your mailchimp email campaigns and your e-commerce site.

Mailchimp Connections#

Mailchimp Connection#

This component can be configured to use an API Key to authenticate the request. An API key can be obtained by following Mailchimp's quickstart guide

InputNotes
Input
API Key
string
/ Required
Notes
Provide a string value for the API Key.

Triggers#

Webhook#

Trigger for handling webhook requests from the Mailchimp platform | key: webhook

You can configure a Mailchimp webhook to send information to a Prismatic webhook URL under certain conditions ("Profile Updates", "Subscribes", "Campaign Sending", etc.).

For more information on configuring webhooks refer to the Mailchimp Docs

Output Example Payload#

{  "payload": {    "headers": {      "accept": "*/*",      "Content-Type": "application/json; charset=UTF-8",      "User-Agent": "MailChimp",      "Host": "hooks.example.prismatic.io"    },    "body": {},    "rawBody": {      "data": { "type": "Buffer", "data": [69, 120, 97, 109, 112, 108, 101] }    },    "queryParameters": None,    "webhookUrls": {      "Flow 1": "https://hooks.example.prismatic.io/trigger/EXAMPLEGbG93Q29uZmlnOmRlNmNmNDMyLTliNWMtN0005NDMxLTRmYzA4ZjViODgxOA=="    },    "webhookApiKeys": { "Flow 1": ["abc-123"] },    "customer": {      "externalId": "customer-example-external-id",      "name": "John Doe"    }  }}

Actions#

Add Customer#

Add a new customer to a store | key: addCustomer

InputNotesExample
Input
Address 1
string
Notes
Provide a string value that represents the 1st address field.
Example
4 Privet Drive
Input
Address 2
string
Notes
Provide a string value that represents the 2nd address field.
Example
apt 4
Input
City
string
Notes
Provide a string value that represents the city.
Example
Palo Alto
Input
Company
string
Notes
Provide a string value that represents the company.
Example
Example Company inc.
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Country
string
Notes
Provide a string value that represents the country
Example
United States
Input
Country Code
string
Notes
Provide a string value that represents the country code
Example
USA
Input
Customer Id
string
Notes
Provide a string value that represents the customer Id.
Example
53ce5example278
Input
Email
string
/ Required
Notes
Provide a string value that represents the email address.
Example
someone@example.com
Input
First Name
string
Notes
Provide a string value that represents a first name.
Example
John
Input
Last Name
string
Notes
Provide a string value that represents a last name.
Example
Doe
Input
Opt In Status
boolean
/ Required
Notes
The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list will be added as Transactional members.
Example
true
Input
Postal Code
string
Notes
Provide a string value that represents the postal code.
Example
90210
Input
Province
string
Notes
Provide a string value that represents the province.
Example
British Colombia
Input
Province Code
string
Notes
Provide a string value that represents the province code.
Example
BC
Input
Store Id
string
Notes
Provide a string value that represents the store Id.
Example
53ce5example278

Add List#

Create a new list in your Mailchimp account | key: addList

InputNotesExample
Input
Address 1
string
Notes
Provide a string value that represents the 1st address field.
Example
4 Privet Drive
Input
Address 2
string
Notes
Provide a string value that represents the 2nd address field.
Example
apt 4
Input
City
string
Notes
Provide a string value that represents the city.
Example
Palo Alto
Input
Company
string
Notes
Provide a string value that represents the company.
Example
Example Company inc.
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Country
string
Notes
Provide a string value that represents the country
Example
United States
Input
Email Type Option
boolean
/ Required
Notes
Whether the list supports multiple formats for emails. When set to true, subscribers can choose whether they want to receive HTML or plain-text emails. When set to false, subscribers will receive HTML emails, with a plain-text alternative backup.
Example
 
Input
From Email
string
/ Required
Notes
The 'from' name on the campaign (not an email address).
Example
John.Doe@gmail.com
Input
From Name
string
/ Required
Notes
The default 'from name' for campaigns sent to this list.
Example
John Doe
Input
Language
string
/ Required
Notes
The default language for this lists's forms.
Example
English
Input
Marketing Permissions
boolean
/ Required
Notes
Whether or not the list has marketing permissions (eg. GDPR) enabled.
Example
 
Input
Name
string
/ Required
Notes
Provide a string value that represents the name of the list.
Example
Example Name
Input
Permission reminder
string
/ Required
Notes
Provide a string value that represents the permission reminder.
Example
This is an example reminder!
Input
Phone
string
Notes
Provide a string value that represents phone number
Example
5556879055
Input
Postal Code
string
Notes
Provide a string value that represents the postal code.
Example
90210
Input
State
string
Notes
Provide a string value that represents the state.
Example
CA
Input
Subject
string
/ Required
Notes
Provide a string value that represents the subject of the email.
Example
This is an example subject

Add Member#

Add a new member to a list | key: addMember

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Email
string
/ Required
Notes
Provide a string value that represents the email address.
Example
someone@example.com
Input
Email Type
string
Notes
Type of email this member asked to get ('html' or 'text').
Example
html
Input
enabled
boolean
Notes
Provide a boolean value for the enabled field.
Example
 
Input
Interests
string
Key Value List
Notes
The key of this object's properties is the Id of the interest in question.
Example
 
Input
Language
string
/ Required
Notes
The default language for this lists's forms.
Example
English
Input
List Id
string
/ Required
Notes
Provide a string value for the Id of the list.
Example
53ce5example278
Input
Marketing Permission Id
string
Notes
Provide a string value for the marketing permission Id
Example
exampleId
Input
Merge Fields
string
Key Value List
Notes
A dictionary of merge fields (audience fields) where the keys are the merge tags. For example, {"FNAME":"Freddie"}
Example
 
Input
Status
string
/ Required
Notes
Subscriber's current status. Possible values: "subscribed", "unsubscribed", "cleaned", "pending", or "transactional".
Example
subscribed
Input
Tags
string
Value List
Notes
The tags that are associated with a member.
Example
 
Input
VIP
boolean
Notes
Provide a boolean to determine VIP status.
Example
 

Add Order#

Create a new order | key: addOrder

InputNotesExample
Input
Address 1
string
Notes
Provide a string value that represents the 1st address field.
Example
4 Privet Drive
Input
Address 2
string
Notes
Provide a string value that represents the 2nd address field.
Example
apt 4
Input
Campaign Id
string
Notes
Provide a string value that represents the campaign Id.
Example
53ce5example278
Input
City
string
Notes
Provide a string value that represents the city.
Example
Palo Alto
Input
Company
string
Notes
Provide a string value that represents the company.
Example
Example Company inc.
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Country
string
Notes
Provide a string value that represents the country
Example
United States
Input
Country Code
string
Notes
Provide a string value that represents the country code
Example
USA
Input
Currency Code
string
Notes
Provide a valid ISO 4217 currency code in the form of a string.
Example
USD
Input
Customer Id
string
Notes
Provide a string value that represents the customer Id.
Example
53ce5example278
Input
Discount Total
string
Notes
The total amount of the discounts to be applied to the price of the order.
Example
89.99
Input
First Name
string
Notes
Provide a string value that represents a first name.
Example
John
Input
Fulfillment Status
string
Notes
Provide a string value that represents the status
Example
shipped
Input
Last Name
string
Notes
Provide a string value that represents a last name.
Example
Doe
Input
Line Id
string
/ Required
Notes
Provide a string value that represents the line Id.
Example
53ce5example278
Input
Opt In Status
boolean
/ Required
Notes
The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list will be added as Transactional members.
Example
true
Input
Order Id
string
Notes
Provide a string value that represents the order id.
Example
Provide a string value for the id of the order in the store.
Input
Order Total
string
Notes
Provide a string value that represents the order total.
Example
78.99
Input
Order Url
string
Notes
Provide a valid URL for the order.
Example
www.example.com
Input
Postal Code
string
Notes
Provide a string value that represents the postal code.
Example
90210
Input
Price
string
/ Required
Notes
Provide a string value that represents the price.
Example
65.87
Input
Product Id
string
/ Required
Notes
Provide a string value that represents the product Id.
Example
53ce5example278
Input
Product Variant Id
string
/ Required
Notes
Provide a string value that represents the product variant Id. (can be the same as product Id)
Example
53ce5example278
Input
Province
string
Notes
Provide a string value that represents the province.
Example
British Colombia
Input
Province Code
string
Notes
Provide a string value that represents the province code.
Example
BC
Input
Quantity
string
/ Required
Notes
Provide a string value that represents the quantity
Example
10
Input
Shipping Total
string
Notes
Provide a number value that represents the shipping total
Example
9.99
Input
Store Id
string
Notes
Provide a string value that represents the store Id.
Example
53ce5example278
Input
Tax Total
string
Notes
Provide a string value that represents the tax total
Example
19.23

Add Products#

Add a new product to a store | key: addProduct

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Description
string
Notes
Provide a string value that represents the description.
Example
This is an example description.
Input
Handle
string
Notes
Provide a string value that represents the handle.
Example
 
Input
Images
string
Value List
Notes
For each list item, provide a JavaScript Object containing the fields from the example.
Example
{id: string, url: string, variant_ids: string[]}
Input
Image URL
string
Notes
Provide a valid URL for the image.
Example
www.example.com
Input
Product Id
string
/ Required
Notes
Provide a string value that represents the product Id.
Example
53ce5example278
Input
Store Id
string
Notes
Provide a string value that represents the store Id.
Example
53ce5example278
Input
Title
string
Notes
Provide a string value that represents the title.
Example
Example Title
Input
Type
string
Notes
Provide a string value that represents the type
Example
text
Input
URL
string
Notes
Provide a valid URL.
Example
www.example.com
Input
Variant Backorders
string
/ Required
Notes
Provide a string value that represents the backorders of the variant product.
Example
 
Input
Variant Image URL
string
/ Required
Notes
Provide a valid URL for the image of the variant product.
Example
www.example.com
Input
Variant Price
string
/ Required
Notes
Provide a string value that represents the price of the variant product.
Example
89.95
Input
Variant Quantity
string
/ Required
Notes
Provide a string value that represents the quantity of the variant product.
Example
135
Input
Variant SKU
string
/ Required
Notes
Provide a string value that represents the SKU of the variant product.
Example
UGG-BB-PUR-06
Input
Variant Title
string
/ Required
Notes
At least one variant is required for each product. A variant can use the same id and title as the parent product.
Example
My Variant Product
Input
Variant URL
string
/ Required
Notes
Provide a valid URL for the variant product.
Example
www.example.com
Input
Variant Visibility
string
/ Required
Notes
Provide a string value that represents the visibility of the variant product.
Example
 
Input
Vendor
string
Notes
Provide a string value that represents the vendor
Example
Acme Inc.

Archive Member#

Archive a list member | key: archiveMember

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
List Id
string
/ Required
Notes
Provide a string value for the Id of the list.
Example
53ce5example278
Input
SubscriberHash
string
/ Required
Notes
The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts email addresses.
Example
example23370f6fe20d1b66b686e1dfb8bac5ba

Create Webhook#

Create a new webhook | key: createWebhook

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Description
string
/ Required
Notes
Provide a string value for the description of the webhook.
Input
Events
string
/ Required
Notes
For each item, provide a string value that represents the event you would like to watch.
Input
Webhook URL
string
/ Required
Notes
Provide a valid url representing where the webhook will send requests. You can use this input to configure a component trigger.

Delete Cart#

Delete a specific cart | key: deleteCart

InputNotesExample
Input
Cart Id
string
/ Required
Notes
Provide a string value that represents the cart Id.
Example
53ce5example278
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Store Id
string
Notes
Provide a string value that represents the store Id.
Example
53ce5example278

Delete Cart Line Items#

Get information about a cart's line items. | key: deleteCartLineItem

InputNotesExample
Input
Cart Id
string
/ Required
Notes
Provide a string value that represents the cart Id.
Example
53ce5example278
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Line Id
string
/ Required
Notes
Provide a string value that represents the line Id.
Example
53ce5example278
Input
Store Id
string
Notes
Provide a string value that represents the store Id.
Example
53ce5example278

Delete List#

Delete a list from your Mailchimp account | key: deleteList

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
List Id
string
/ Required
Notes
Provide a string value for the Id of the list.
Example
53ce5example278

Delete Member#

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 | key: deleteMember

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
List Id
string
/ Required
Notes
Provide a string value for the Id of the list.
Example
53ce5example278
Input
SubscriberHash
string
/ Required
Notes
The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts email addresses.
Example
example23370f6fe20d1b66b686e1dfb8bac5ba

Delete Order#

Delete an order | key: deleteOrder

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Order Id
string
Notes
Provide a string value that represents the order id.
Example
Provide a string value for the id of the order in the store.
Input
Store Id
string
Notes
Provide a string value that represents the store Id.
Example
53ce5example278

Delete Order Line Item#

Delete an order Line Item | key: deleteOrderLineItem

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Order Id
string
Notes
Provide a string value that represents the order id.
Example
Provide a string value for the id of the order in the store.
Input
Store Id
string
Notes
Provide a string value that represents the store Id.
Example
53ce5example278

Delete Product#

Delete a product from a store | key: deleteProduct

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Product Id
string
/ Required
Notes
Provide a string value that represents the product Id.
Example
53ce5example278
Input
Store Id
string
Notes
Provide a string value that represents the store Id.
Example
53ce5example278

Get Cart#

Get information about a specific cart | key: getCart

InputNotesExample
Input
Cart Id
string
/ Required
Notes
Provide a string value that represents the cart Id.
Example
53ce5example278
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Store Id
string
Notes
Provide a string value that represents the store Id.
Example
53ce5example278

Get Cart Line Item#

Get information about a cart's specific line item | key: getCartLineItem

InputNotesExample
Input
Cart Id
string
/ Required
Notes
Provide a string value that represents the cart Id.
Example
53ce5example278
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Line Id
string
/ Required
Notes
Provide a string value that represents the line Id.
Example
53ce5example278
Input
Store Id
string
Notes
Provide a string value that represents the store Id.
Example
53ce5example278

Get Customer#

Get information about a store's specific customer | key: deleteCustomer

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Customer Id
string
Notes
Provide a string value that represents the customer Id.
Example
53ce5example278
Input
Store Id
string
Notes
Provide a string value that represents the store Id.
Example
53ce5example278

Get Customer#

Get information about a store's specific customer | key: getCustomer

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Customer Id
string
Notes
Provide a string value that represents the customer Id.
Example
53ce5example278
Input
Store Id
string
Notes
Provide a string value that represents the store Id.
Example
53ce5example278

Get Customer#

Get information about a store's specific customer | key: getCustomerInfo

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Customer Id
string
Notes
Provide a string value that represents the customer Id.
Example
53ce5example278
Input
Store Id
string
Notes
Provide a string value that represents the store Id.
Example
53ce5example278

Get List#

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. | key: getList

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
List Id
string
/ Required
Notes
Provide a string value for the Id of the list.
Example
53ce5example278

Get Lists Info#

Get information about all lists in the account | key: getListsInfo

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Result Count
string
Notes
Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.
Example
20
Input
Offset
string
Notes
Provide an integer value for the page offset for the given object's results.
Example
3

Get Member#

Get information about a specific list member, including a currently subscribed, unsubscribed, or bounced member | key: getMember

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
List Id
string
/ Required
Notes
Provide a string value for the Id of the list.
Example
53ce5example278
Input
SubscriberHash
string
/ Required
Notes
The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts email addresses.
Example
example23370f6fe20d1b66b686e1dfb8bac5ba

Get Order#

Get information about a specific order | key: getOrderInfo

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Order Id
string
Notes
Provide a string value that represents the order id.
Example
Provide a string value for the id of the order in the store.
Input
Store Id
string
Notes
Provide a string value that represents the store Id.
Example
53ce5example278

Get Order Line Item#

Get an order Line Item | key: getOrderLineItem

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Line Id
string
/ Required
Notes
Provide a string value that represents the line Id.
Example
53ce5example278
Input
Order Id
string
Notes
Provide a string value that represents the order id.
Example
Provide a string value for the id of the order in the store.
Input
Store Id
string
Notes
Provide a string value that represents the store Id.
Example
53ce5example278

Get Product#

Get information about a specific product | key: getProductInfo

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Product Id
string
/ Required
Notes
Provide a string value that represents the product Id.
Example
53ce5example278
Input
Store Id
string
Notes
Provide a string value that represents the store Id.
Example
53ce5example278

Get Store#

Get information about a specific store | key: getStore

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Store Id
string
Notes
Provide a string value that represents the store Id.
Example
53ce5example278

List Account Orders#

Get information about an account's orders | key: listAccountOrders

InputNotes
Input
Connection
connection
/ Required
Notes
 

List Campaigns#

Get all campaigns in an account | key: listCampaigns

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Result Count
string
Notes
Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.
Example
20
Input
Offset
string
Notes
Provide an integer value for the page offset for the given object's results.
Example
3

List Cart Line Items#

Get information about a cart's line items. | key: listCartLineItem

InputNotesExample
Input
Cart Id
string
/ Required
Notes
Provide a string value that represents the cart Id.
Example
53ce5example278
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Result Count
string
Notes
Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.
Example
20
Input
Offset
string
Notes
Provide an integer value for the page offset for the given object's results.
Example
3
Input
Store Id
string
Notes
Provide a string value that represents the store Id.
Example
53ce5example278

List Carts#

Get information about a store's carts | key: listCarts

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Result Count
string
Notes
Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.
Example
20
Input
Offset
string
Notes
Provide an integer value for the page offset for the given object's results.
Example
3
Input
Store Id
string
Notes
Provide a string value that represents the store Id.
Example
53ce5example278

List Customers#

Get information about a store's customers | key: listCustomers

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Result Count
string
Notes
Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.
Example
20
Input
Offset
string
Notes
Provide an integer value for the page offset for the given object's results.
Example
3
Input
Store Id
string
Notes
Provide a string value that represents the store Id.
Example
53ce5example278

List Members#

Get information about members in a specific Mailchimp list | key: listMembers

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Result Count
string
Notes
Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.
Example
20
Input
List Id
string
/ Required
Notes
Provide a string value for the Id of the list.
Example
53ce5example278
Input
Offset
string
Notes
Provide an integer value for the page offset for the given object's results.
Example
3

Output Example Payload#

{  "data": {}}

List Order Line Items#

List Order Line items | key: listOrderLineItems

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Order Id
string
Notes
Provide a string value that represents the order id.
Example
Provide a string value for the id of the order in the store.
Input
Store Id
string
Notes
Provide a string value that represents the store Id.
Example
53ce5example278

List Orders#

List all the orders in a store | key: listOrders

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Result Count
string
Notes
Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.
Example
20
Input
Offset
string
Notes
Provide an integer value for the page offset for the given object's results.
Example
3
Input
Store Id
string
Notes
Provide a string value that represents the store Id.
Example
53ce5example278

List Products#

List all products from a store | key: listProducts

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Result Count
string
Notes
Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.
Example
20
Input
Offset
string
Notes
Provide an integer value for the page offset for the given object's results.
Example
3
Input
Store Id
string
Notes
Provide a string value that represents the store Id.
Example
53ce5example278

List Stores#

Get information about all stores in the account | key: listStores

InputNotes
Input
Connection
connection
/ Required
Notes
 

Ping#

Send a ping to determine the status of the Mailchimp servers | key: ping

InputNotes
Input
Connection
connection
/ Required
Notes
 

Send Campaign#

Send a Mailchimp campaign. For RSS Campaigns, the campaign will send according to its schedule. All other campaigns will send immediately. | key: sendCampaign

InputNotesExample
Input
Campaign Id
string
Notes
Provide a string value that represents the campaign Id.
Example
53ce5example278
Input
Connection
connection
/ Required
Notes
 
Example
 

Update Customer#

Update a specific customer's information | key: updateCustomer

InputNotesExample
Input
Address 1
string
Notes
Provide a string value that represents the 1st address field.
Example
4 Privet Drive
Input
Address 2
string
Notes
Provide a string value that represents the 2nd address field.
Example
apt 4
Input
City
string
Notes
Provide a string value that represents the city.
Example
Palo Alto
Input
Company
string
Notes
Provide a string value that represents the company.
Example
Example Company inc.
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Country
string
Notes
Provide a string value that represents the country
Example
United States
Input
Country Code
string
Notes
Provide a string value that represents the country code
Example
USA
Input
Customer Id
string
Notes
Provide a string value that represents the customer Id.
Example
53ce5example278
Input
First Name
string
Notes
Provide a string value that represents a first name.
Example
John
Input
Last Name
string
Notes
Provide a string value that represents a last name.
Example
Doe
Input
Opt In Status
boolean
/ Required
Notes
The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list will be added as Transactional members.
Example
true
Input
Postal Code
string
Notes
Provide a string value that represents the postal code.
Example
90210
Input
Province
string
Notes
Provide a string value that represents the province.
Example
British Colombia
Input
Province Code
string
Notes
Provide a string value that represents the province code.
Example
BC
Input
Store Id
string
Notes
Provide a string value that represents the store Id.
Example
53ce5example278

Update List#

Update the information or metadata of a list | key: updateList

InputNotesExample
Input
Address 1
string
Notes
Provide a string value that represents the 1st address field.
Example
4 Privet Drive
Input
Address 2
string
Notes
Provide a string value that represents the 2nd address field.
Example
apt 4
Input
City
string
Notes
Provide a string value that represents the city.
Example
Palo Alto
Input
Company
string
Notes
Provide a string value that represents the company.
Example
Example Company inc.
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Country
string
Notes
Provide a string value that represents the country
Example
United States
Input
Email Type Option
boolean
/ Required
Notes
Whether the list supports multiple formats for emails. When set to true, subscribers can choose whether they want to receive HTML or plain-text emails. When set to false, subscribers will receive HTML emails, with a plain-text alternative backup.
Example
 
Input
From Email
string
/ Required
Notes
The 'from' name on the campaign (not an email address).
Example
John.Doe@gmail.com
Input
From Name
string
/ Required
Notes
The default 'from name' for campaigns sent to this list.
Example
John Doe
Input
Language
string
/ Required
Notes
The default language for this lists's forms.
Example
English
Input
List Id
string
/ Required
Notes
Provide a string value for the Id of the list.
Example
53ce5example278
Input
Marketing Permissions
boolean
/ Required
Notes
Whether or not the list has marketing permissions (eg. GDPR) enabled.
Example
 
Input
Name
string
/ Required
Notes
Provide a string value that represents the name of the list.
Example
Example Name
Input
Permission reminder
string
/ Required
Notes
Provide a string value that represents the permission reminder.
Example
This is an example reminder!
Input
Phone
string
Notes
Provide a string value that represents phone number
Example
5556879055
Input
State
string
Notes
Provide a string value that represents the state.
Example
CA
Input
Subject
string
/ Required
Notes
Provide a string value that represents the subject of the email.
Example
This is an example subject

Update Member#

Update a specific member in a given list | key: updateMember

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Email
string
Notes
Provide a string value that represents the email address.
Example
someone@example.com
Input
Email Type
string
Notes
Type of email this member asked to get ('html' or 'text').
Example
html
Input
enabled
boolean
Notes
Provide a boolean value for the enabled field.
Example
 
Input
Interests
string
Key Value List
Notes
The key of this object's properties is the Id of the interest in question.
Example
 
Input
Language
string
Notes
The default language for this lists's forms.
Example
English
Input
List Id
string
/ Required
Notes
Provide a string value for the Id of the list.
Example
53ce5example278
Input
Marketing Permission Id
string
Notes
Provide a string value for the marketing permission Id
Example
exampleId
Input
Merge Fields
string
Key Value List
Notes
A dictionary of merge fields (audience fields) where the keys are the merge tags. For example, {"FNAME":"Freddie"}
Example
 
Input
Status
string
Notes
Subscriber's current status. Possible values: "subscribed", "unsubscribed", "cleaned", "pending", or "transactional".
Example
subscribed
Input
SubscriberHash
string
/ Required
Notes
The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts email addresses.
Example
example23370f6fe20d1b66b686e1dfb8bac5ba
Input
Tags
string
Value List
Notes
The tags that are associated with a member.
Example
 
Input
VIP
boolean
Notes
Provide a boolean to determine VIP status.
Example
 

Update Product#

Update a product from a store | key: updateProduct

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Description
string
Notes
Provide a string value that represents the description.
Example
This is an example description.
Input
Handle
string
Notes
Provide a string value that represents the handle.
Example
 
Input
Image URL
string
Notes
Provide a valid URL for the image.
Example
www.example.com
Input
Product Id
string
/ Required
Notes
Provide a string value that represents the product Id.
Example
53ce5example278
Input
Store Id
string
Notes
Provide a string value that represents the store Id.
Example
53ce5example278
Input
Title
string
Notes
Provide a string value that represents the title.
Example
Example Title
Input
Type
string
Notes
Provide a string value that represents the type
Example
text
Input
URL
string
Notes
Provide a valid URL.
Example
www.example.com
Input
Variant Backorders
string
Notes
Provide a string value that represents the backorders of the variant product.
Example
 
Input
Variant Image URL
string
Notes
Provide a valid URL for the image of the variant product.
Example
www.example.com
Input
Variant Price
string
Notes
Provide a string value that represents the price of the variant product.
Example
89.95
Input
Variant Quantity
string
Notes
Provide a string value that represents the quantity of the variant product.
Example
135
Input
Variant SKU
string
Notes
Provide a string value that represents the SKU of the variant product.
Example
UGG-BB-PUR-06
Input
Variant Title
string
Notes
At least one variant is required for each product. A variant can use the same id and title as the parent product.
Example
My Variant Product
Input
Variant URL
string
Notes
Provide a valid URL for the variant product.
Example
www.example.com
Input
Variant Visibility
string
Notes
Provide a string value that represents the visibility of the variant product.
Example
 
Input
Vendor
string
Notes
Provide a string value that represents the vendor
Example
Acme Inc.