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.

Authorization Notes#

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

Mailchimp Connections#

Mailchimp Connection#

InputKeyNotes

API Key

string
/ Required
apiKeyProvide 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

InputKeyNotesExample

Address 1

string
address1Provide a string value that represents the 1st address field.4 Privet Drive

Address 2

string
address2Provide a string value that represents the 2nd address field.apt 4

City

string
cityProvide a string value that represents the city.Palo Alto

Company

string
companyProvide a string value that represents the company.Example Company inc.

Country

string
countryProvide a string value that represents the countryUnited States

Country Code

string
countryCodeProvide a string value that represents the country codeUSA

Customer Id

string
customerIdProvide a string value that represents the customer Id.53ce5example278

Email

string
/ Required
emailProvide a string value that represents the email address.someone@example.com

First Name

string
firstNameProvide a string value that represents a first name.John

Last Name

string
lastNameProvide a string value that represents a last name.Doe

Connection

connection
/ Required
mailchimpConnection

Opt In Status

boolean
/ Required
optInStatusThe 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.true

Postal Code

string
postalCodeProvide a string value that represents the postal code.90210

Province

string
provinceProvide a string value that represents the province.British Colombia

Province Code

string
provinceCodeProvide a string value that represents the province code.BC

Store Id

string
storeIdProvide a string value that represents the store Id.53ce5example278

Add List#

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

InputKeyNotesExample

Address 1

string
address1Provide a string value that represents the 1st address field.4 Privet Drive

Address 2

string
address2Provide a string value that represents the 2nd address field.apt 4

City

string
cityProvide a string value that represents the city.Palo Alto

Company

string
companyProvide a string value that represents the company.Example Company inc.

Country

string
countryProvide a string value that represents the countryUnited States

Email Type Option

boolean
/ Required
emailTypeOptionWhether 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.

From Email

string
/ Required
fromEmailThe 'from' name on the campaign (not an email address).John.Doe@gmail.com

From Name

string
/ Required
fromNameThe default 'from name' for campaigns sent to this list.John Doe

Language

string
/ Required
languageThe default language for this lists's forms.English

Connection

connection
/ Required
mailchimpConnection

Marketing Permissions

boolean
/ Required
marketingPermissionsWhether or not the list has marketing permissions (eg. GDPR) enabled.

Name

string
/ Required
nameProvide a string value that represents the name of the list.Example Name

Permission reminder

string
/ Required
permissionReminderProvide a string value that represents the permission reminder.This is an example reminder!

Phone

string
phoneProvide a string value that represents phone number5556879055

Postal Code

string
postalCodeProvide a string value that represents the postal code.90210

State

string
stateProvide a string value that represents the state.CA

Subject

string
/ Required
subjectProvide a string value that represents the subject of the email.This is an example subject

Add Member#

Add a new member to a list | key: addMember

InputKeyNotesExample

Email

string
/ Required
emailProvide a string value that represents the email address.someone@example.com

Email Type

string
emailTypeType of email this member asked to get ('html' or 'text').html

enabled

boolean
enabledProvide a boolean value for the enabled field.

Interests

string
Key Value List
interestsThe key of this object's properties is the Id of the interest in question.

Language

string
/ Required
languageThe default language for this lists's forms.English

List Id

string
/ Required
listIdProvide a string value for the Id of the list.53ce5example278

Connection

connection
/ Required
mailchimpConnection

Marketing Permission Id

string
marketingPermissionIdProvide a string value for the marketing permission IdexampleId

Merge Fields

string
Key Value List
mergeFieldsA dictionary of merge fields (audience fields) where the keys are the merge tags. For example, {"FNAME":"Freddie"}

Status

string
/ Required
statusSubscriber's current status. Possible values: "subscribed", "unsubscribed", "cleaned", "pending", or "transactional".subscribed

Tags

string
Value List
tagsThe tags that are associated with a member.

VIP

boolean
vipProvide a boolean to determine VIP status.

Add Order#

Create a new order | key: addOrder

InputKeyNotesExample

Address 1

string
address1Provide a string value that represents the 1st address field.4 Privet Drive

Address 2

string
address2Provide a string value that represents the 2nd address field.apt 4

Campaign Id

string
campaignIdProvide a string value that represents the campaign Id.53ce5example278

City

string
cityProvide a string value that represents the city.Palo Alto

Company

string
companyProvide a string value that represents the company.Example Company inc.

Country

string
countryProvide a string value that represents the countryUnited States

Country Code

string
countryCodeProvide a string value that represents the country codeUSA

Currency Code

string
currencyCodeProvide a valid ISO 4217 currency code in the form of a string.USD

Customer Id

string
customerIdProvide a string value that represents the customer Id.53ce5example278

Discount Total

string
discountTotalThe total amount of the discounts to be applied to the price of the order.89.99

First Name

string
firstNameProvide a string value that represents a first name.John

Fulfillment Status

string
fulfillmentStatusProvide a string value that represents the statusshipped

Last Name

string
lastNameProvide a string value that represents a last name.Doe

Line Id

string
/ Required
lineIdProvide a string value that represents the line Id.53ce5example278

Connection

connection
/ Required
mailchimpConnection

Opt In Status

boolean
/ Required
optInStatusThe 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.true

Order Id

string
orderIdProvide a string value that represents the order id.Provide a string value for the id of the order in the store.

Order Total

string
orderTotalProvide a string value that represents the order total.78.99

Order Url

string
orderUrlProvide a valid URL for the order.www.example.com

Postal Code

string
postalCodeProvide a string value that represents the postal code.90210

Price

string
/ Required
priceProvide a string value that represents the price.65.87

Product Id

string
/ Required
productIdProvide a string value that represents the product Id.53ce5example278

Product Variant Id

string
/ Required
productVariantIdProvide a string value that represents the product variant Id. (can be the same as product Id)53ce5example278

Province

string
provinceProvide a string value that represents the province.British Colombia

Province Code

string
provinceCodeProvide a string value that represents the province code.BC

Quantity

string
/ Required
quantityProvide a string value that represents the quantity10

Shipping Total

string
shippingTotalProvide a number value that represents the shipping total9.99

Store Id

string
storeIdProvide a string value that represents the store Id.53ce5example278

Tax Total

string
taxTotalProvide a string value that represents the tax total19.23

Add Products#

Add a new product to a store | key: addProduct

InputKeyNotesExample

Description

string
descriptionProvide a string value that represents the description.This is an example description.

Handle

string
handleProvide a string value that represents the handle.

Images

string
Value List
imagesFor each list item, provide a JavaScript Object containing the fields from the example.{id: string, url: string, variant_ids: string[]}

Image URL

string
imageUrlProvide a valid URL for the image.www.example.com

Connection

connection
/ Required
mailchimpConnection

Product Id

string
/ Required
productIdProvide a string value that represents the product Id.53ce5example278

Store Id

string
storeIdProvide a string value that represents the store Id.53ce5example278

Title

string
titleProvide a string value that represents the title.Example Title

Type

string
typeProvide a string value that represents the typetext

URL

string
urlProvide a valid URL.www.example.com

Variant Backholders

string
/ Required
variantBackholdersProvide a string value that represents the backholders of the variant product.

Variant Image URL

string
/ Required
variantImageUrlProvide a valid URL for the image of the variant product.www.example.com

Variant Price

string
/ Required
variantPriceProvide a string value that represents the price of the variant product.89.95

Variant Quantity

string
/ Required
variantQuantityProvide a string value that represents the quantity of the variant product.135

Variant SKU

string
/ Required
variantSkuProvide a string value that represents the SKU of the variant product.UGG-BB-PUR-06

Variant Title

string
/ Required
variantTitleAt least one variant is required for each product. A variant can use the same id and title as the parent product.My Variant Product

Variant URL

string
/ Required
variantUrlProvide a valid URL for the variant product.www.example.com

Variant Visibility

string
/ Required
variantVisibilityProvide a string value that represents the visibility of the variant product.

Vendor

string
vendorProvide a string value that represents the vendorAcme Inc.

Archive Member#

Archive a list member | key: archiveMember

InputKeyNotesExample

List Id

string
/ Required
listIdProvide a string value for the Id of the list.53ce5example278

Connection

connection
/ Required
mailchimpConnection

SubscriberHash

string
/ Required
subscriberHashThe MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts email addresses.example23370f6fe20d1b66b686e1dfb8bac5ba

Create Webhook#

Create a new webhook | key: createWebhook

InputKeyNotes

Connection

connection
/ Required
mailchimpConnection

Description

string
/ Required
webhookDescriptionProvide a string value for the description of the webhook.

Events

string
/ Required
webhookEventsFor each item, provide a string value that represents the event you would like to watch.

Webhook URL

string
/ Required
webhookUrlProvide 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

InputKeyNotesExample

Cart Id

string
/ Required
cartIdProvide a string value that represents the cart Id.53ce5example278

Connection

connection
/ Required
mailchimpConnection

Store Id

string
storeIdProvide a string value that represents the store Id.53ce5example278

Delete Cart Line Items#

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

InputKeyNotesExample

Cart Id

string
/ Required
cartIdProvide a string value that represents the cart Id.53ce5example278

Line Id

string
/ Required
lineIdProvide a string value that represents the line Id.53ce5example278

Connection

connection
/ Required
mailchimpConnection

Store Id

string
storeIdProvide a string value that represents the store Id.53ce5example278

Delete List#

Delete a list from your Mailchimp account | key: deleteList

InputKeyNotesExample

List Id

string
/ Required
listIdProvide a string value for the Id of the list.53ce5example278

Connection

connection
/ Required
mailchimpConnection

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

InputKeyNotesExample

List Id

string
/ Required
listIdProvide a string value for the Id of the list.53ce5example278

Connection

connection
/ Required
mailchimpConnection

SubscriberHash

string
/ Required
subscriberHashThe MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts email addresses.example23370f6fe20d1b66b686e1dfb8bac5ba

Delete Order#

Delete an order | key: deleteOrder

InputKeyNotesExample

Connection

connection
/ Required
mailchimpConnection

Order Id

string
orderIdProvide a string value that represents the order id.Provide a string value for the id of the order in the store.

Store Id

string
storeIdProvide a string value that represents the store Id.53ce5example278

Delete Order Line Item#

Delete an order Line Item | key: deleteOrderLineItem

InputKeyNotesExample

Connection

connection
/ Required
mailchimpConnection

Order Id

string
orderIdProvide a string value that represents the order id.Provide a string value for the id of the order in the store.

Store Id

string
storeIdProvide a string value that represents the store Id.53ce5example278

Delete Product#

Delete a product from a store | key: deleteProduct

InputKeyNotesExample

Connection

connection
/ Required
mailchimpConnection

Product Id

string
/ Required
productIdProvide a string value that represents the product Id.53ce5example278

Store Id

string
storeIdProvide a string value that represents the store Id.53ce5example278

Get Cart#

Get information about a specific cart | key: getCart

InputKeyNotesExample

Cart Id

string
/ Required
cartIdProvide a string value that represents the cart Id.53ce5example278

Connection

connection
/ Required
mailchimpConnection

Store Id

string
storeIdProvide a string value that represents the store Id.53ce5example278

Get Cart Line Item#

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

InputKeyNotesExample

Cart Id

string
/ Required
cartIdProvide a string value that represents the cart Id.53ce5example278

Line Id

string
/ Required
lineIdProvide a string value that represents the line Id.53ce5example278

Connection

connection
/ Required
mailchimpConnection

Store Id

string
storeIdProvide a string value that represents the store Id.53ce5example278

Get Customer#

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

InputKeyNotesExample

Customer Id

string
customerIdProvide a string value that represents the customer Id.53ce5example278

Connection

connection
/ Required
mailchimpConnection

Store Id

string
storeIdProvide a string value that represents the store Id.53ce5example278

Get Customer#

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

InputKeyNotesExample

Customer Id

string
customerIdProvide a string value that represents the customer Id.53ce5example278

Connection

connection
/ Required
mailchimpConnection

Store Id

string
storeIdProvide a string value that represents the store Id.53ce5example278

Get Customer#

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

InputKeyNotesExample

Customer Id

string
customerIdProvide a string value that represents the customer Id.53ce5example278

Connection

connection
/ Required
mailchimpConnection

Store Id

string
storeIdProvide a string value that represents the store Id.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

InputKeyNotesExample

List Id

string
/ Required
listIdProvide a string value for the Id of the list.53ce5example278

Connection

connection
/ Required
mailchimpConnection

Get Lists Info#

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

InputKeyNotesExample

Result Count

string
countProvide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.20

Connection

connection
/ Required
mailchimpConnection

Offset

string
offsetProvide an integer value for the page offset for the given object's results.3

Get Member#

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

InputKeyNotesExample

List Id

string
/ Required
listIdProvide a string value for the Id of the list.53ce5example278

Connection

connection
/ Required
mailchimpConnection

SubscriberHash

string
/ Required
subscriberHashThe MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts email addresses.example23370f6fe20d1b66b686e1dfb8bac5ba

Get Order#

Get information about a specific order | key: getOrderInfo

InputKeyNotesExample

Connection

connection
/ Required
mailchimpConnection

Order Id

string
orderIdProvide a string value that represents the order id.Provide a string value for the id of the order in the store.

Store Id

string
storeIdProvide a string value that represents the store Id.53ce5example278

Get Order Line Item#

Get an order Line Item | key: getOrderLineItem

InputKeyNotesExample

Line Id

string
/ Required
lineIdProvide a string value that represents the line Id.53ce5example278

Connection

connection
/ Required
mailchimpConnection

Order Id

string
orderIdProvide a string value that represents the order id.Provide a string value for the id of the order in the store.

Store Id

string
storeIdProvide a string value that represents the store Id.53ce5example278

Get Product#

Get information about a specific product | key: getProductInfo

InputKeyNotesExample

Connection

connection
/ Required
mailchimpConnection

Product Id

string
/ Required
productIdProvide a string value that represents the product Id.53ce5example278

Store Id

string
storeIdProvide a string value that represents the store Id.53ce5example278

Get Store#

Get information about a specific store | key: getStore

InputKeyNotesExample

Connection

connection
/ Required
mailchimpConnection

Store Id

string
storeIdProvide a string value that represents the store Id.53ce5example278

List Account Orders#

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

InputKeyNotes

Connection

connection
/ Required
mailchimpConnection

List Campaigns#

Get all campaigns in an account | key: listCampaigns

InputKeyNotesExample

Result Count

string
countProvide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.20

Connection

connection
/ Required
mailchimpConnection

Offset

string
offsetProvide an integer value for the page offset for the given object's results.3

List Cart Line Items#

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

InputKeyNotesExample

Cart Id

string
/ Required
cartIdProvide a string value that represents the cart Id.53ce5example278

Result Count

string
countProvide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.20

Connection

connection
/ Required
mailchimpConnection

Offset

string
offsetProvide an integer value for the page offset for the given object's results.3

Store Id

string
storeIdProvide a string value that represents the store Id.53ce5example278

List Carts#

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

InputKeyNotesExample

Result Count

string
countProvide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.20

Connection

connection
/ Required
mailchimpConnection

Offset

string
offsetProvide an integer value for the page offset for the given object's results.3

Store Id

string
storeIdProvide a string value that represents the store Id.53ce5example278

List Customers#

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

InputKeyNotesExample

Result Count

string
countProvide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.20

Connection

connection
/ Required
mailchimpConnection

Offset

string
offsetProvide an integer value for the page offset for the given object's results.3

Store Id

string
storeIdProvide a string value that represents the store Id.53ce5example278

List Members#

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

InputKeyNotesExample

Result Count

string
countProvide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.20

List Id

string
/ Required
listIdProvide a string value for the Id of the list.53ce5example278

Connection

connection
/ Required
mailchimpConnection

Offset

string
offsetProvide an integer value for the page offset for the given object's results.3

Output Example Payload#

{  "data": {}}

List Order Line Items#

List Order Line items | key: listOrderLineItems

InputKeyNotesExample

Connection

connection
/ Required
mailchimpConnection

Order Id

string
orderIdProvide a string value that represents the order id.Provide a string value for the id of the order in the store.

Store Id

string
storeIdProvide a string value that represents the store Id.53ce5example278

List Orders#

List all the orders in a store | key: listOrders

InputKeyNotesExample

Result Count

string
countProvide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.20

Connection

connection
/ Required
mailchimpConnection

Offset

string
offsetProvide an integer value for the page offset for the given object's results.3

Store Id

string
storeIdProvide a string value that represents the store Id.53ce5example278

List Products#

List all products from a store | key: listProducts

InputKeyNotesExample

Result Count

string
countProvide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.20

Connection

connection
/ Required
mailchimpConnection

Offset

string
offsetProvide an integer value for the page offset for the given object's results.3

Store Id

string
storeIdProvide a string value that represents the store Id.53ce5example278

List Stores#

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

InputKeyNotes

Connection

connection
/ Required
mailchimpConnection

Ping#

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

InputKeyNotes

Connection

connection
/ Required
mailchimpConnection

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

InputKeyNotesExample

Campaign Id

string
campaignIdProvide a string value that represents the campaign Id.53ce5example278

Connection

connection
/ Required
mailchimpConnection

Update Customer#

Update a specific customer's information | key: updateCustomer

InputKeyNotesExample

Address 1

string
address1Provide a string value that represents the 1st address field.4 Privet Drive

Address 2

string
address2Provide a string value that represents the 2nd address field.apt 4

City

string
cityProvide a string value that represents the city.Palo Alto

Company

string
companyProvide a string value that represents the company.Example Company inc.

Country

string
countryProvide a string value that represents the countryUnited States

Country Code

string
countryCodeProvide a string value that represents the country codeUSA

Customer Id

string
customerIdProvide a string value that represents the customer Id.53ce5example278

First Name

string
firstNameProvide a string value that represents a first name.John

Last Name

string
lastNameProvide a string value that represents a last name.Doe

Connection

connection
/ Required
mailchimpConnection

Opt In Status

boolean
/ Required
optInStatusThe 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.true

Postal Code

string
postalCodeProvide a string value that represents the postal code.90210

Province

string
provinceProvide a string value that represents the province.British Colombia

Province Code

string
provinceCodeProvide a string value that represents the province code.BC

Store Id

string
storeIdProvide a string value that represents the store Id.53ce5example278

Update List#

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

InputKeyNotesExample

Address 1

string
address1Provide a string value that represents the 1st address field.4 Privet Drive

Address 2

string
address2Provide a string value that represents the 2nd address field.apt 4

City

string
cityProvide a string value that represents the city.Palo Alto

Company

string
companyProvide a string value that represents the company.Example Company inc.

Country

string
countryProvide a string value that represents the countryUnited States

Email Type Option

boolean
/ Required
emailTypeOptionWhether 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.

From Email

string
/ Required
fromEmailThe 'from' name on the campaign (not an email address).John.Doe@gmail.com

From Name

string
/ Required
fromNameThe default 'from name' for campaigns sent to this list.John Doe

Language

string
/ Required
languageThe default language for this lists's forms.English

List Id

string
/ Required
listIdProvide a string value for the Id of the list.53ce5example278

Connection

connection
/ Required
mailchimpConnection

Marketing Permissions

boolean
/ Required
marketingPermissionsWhether or not the list has marketing permissions (eg. GDPR) enabled.

Name

string
/ Required
nameProvide a string value that represents the name of the list.Example Name

Permission reminder

string
/ Required
permissionReminderProvide a string value that represents the permission reminder.This is an example reminder!

Phone

string
phoneProvide a string value that represents phone number5556879055

State

string
stateProvide a string value that represents the state.CA

Subject

string
/ Required
subjectProvide a string value that represents the subject of the email.This is an example subject

Update Member#

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

InputKeyNotesExample

Email

string
emailProvide a string value that represents the email address.someone@example.com

Email Type

string
emailTypeType of email this member asked to get ('html' or 'text').html

enabled

boolean
enabledProvide a boolean value for the enabled field.

Interests

string
Key Value List
interestsThe key of this object's properties is the Id of the interest in question.

Language

string
languageThe default language for this lists's forms.English

List Id

string
/ Required
listIdProvide a string value for the Id of the list.53ce5example278

Connection

connection
/ Required
mailchimpConnection

Marketing Permission Id

string
marketingPermissionIdProvide a string value for the marketing permission IdexampleId

Merge Fields

string
Key Value List
mergeFieldsA dictionary of merge fields (audience fields) where the keys are the merge tags. For example, {"FNAME":"Freddie"}

Status

string
statusSubscriber's current status. Possible values: "subscribed", "unsubscribed", "cleaned", "pending", or "transactional".subscribed

SubscriberHash

string
/ Required
subscriberHashThe MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts email addresses.example23370f6fe20d1b66b686e1dfb8bac5ba

Tags

string
Value List
tagsThe tags that are associated with a member.

VIP

boolean
vipProvide a boolean to determine VIP status.

Update Product#

Update a product from a store | key: updateProduct

InputKeyNotesExample

Description

string
descriptionProvide a string value that represents the description.This is an example description.

Handle

string
handleProvide a string value that represents the handle.

Image URL

string
imageUrlProvide a valid URL for the image.www.example.com

Connection

connection
/ Required
mailchimpConnection

Product Id

string
/ Required
productIdProvide a string value that represents the product Id.53ce5example278

Store Id

string
storeIdProvide a string value that represents the store Id.53ce5example278

Title

string
titleProvide a string value that represents the title.Example Title

Type

string
typeProvide a string value that represents the typetext

URL

string
urlProvide a valid URL.www.example.com

Variant Backholders

string
variantBackholdersProvide a string value that represents the backholders of the variant product.

Variant Image URL

string
variantImageUrlProvide a valid URL for the image of the variant product.www.example.com

Variant Price

string
variantPriceProvide a string value that represents the price of the variant product.89.95

Variant Quantity

string
variantQuantityProvide a string value that represents the quantity of the variant product.135

Variant SKU

string
variantSkuProvide a string value that represents the SKU of the variant product.UGG-BB-PUR-06

Variant Title

string
variantTitleAt least one variant is required for each product. A variant can use the same id and title as the parent product.My Variant Product

Variant URL

string
variantUrlProvide a valid URL for the variant product.www.example.com

Variant Visibility

string
variantVisibilityProvide a string value that represents the visibility of the variant product.

Vendor

string
vendorProvide a string value that represents the vendorAcme Inc.