About this integration
Email marketing and audience automation platform. Use it from the workflow canvas with no custom glue script required.
This integration exposes 13 triggers, 61 search modules and 91 actions as workflow nodes. Authentication uses basic or oauth authentication.
How to connect
The credential form asks for API Key, Data Center, Client ID, and Client Secret.
Prefer the interactive builder form? Open it on the app page.
Sign in and approve access — your password is never shared with WEXTL®, and you can revoke access from the provider at any time.
Enter your credentials below. WEXTL stores them encrypted and uses them only to call the API on your behalf.
You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
Connecting Mailchimp to WEXTL®
| Field | Type | Help |
|---|---|---|
API KeyRequired | password | Go to API Keys in your account, create a new key, and copy it immediately since it won't be shown again. |
Data CenterRequired | text | Your data center is the text after the last hyphen in your API key (e.g. abcd1234-us6 → us6) |
| Field | Type | Help |
|---|---|---|
Client IDRequired | text | Navigate to Mailchimp → Registered Apps, clicking Register An App, completing the form, and creating the app to obtain your client_id and client_secret |
Client SecretRequired | password | Navigate to Mailchimp → Registered Apps, clicking Register An App, completing the form, and creating the app to obtain your client_id and client_secret |
Data CenterRequired | text | Your data center is the text after the last hyphen in your API key (e.g. abcd1234-us6 → us6) |
Use it in workflow automation
Start with Watch Automations, then add Archive a Contact.
The canvas below runs Watch Automations into Archive a Contact — watch the video, then drop a node onto the canvas.
Select the Watch Campaign Feedback trigger and the workflow fires automatically when the event occurs — no polling required.
Then add Create a Campaign as the next node. Branch, filter, or hand off to other integrations from there.
The integration includes 104 ready-made modules for communication work — each run logs its inputs and outputs for debugging.
Mailchimp workflow on the canvas: Watch Campaign Feedback then Create a Campaign
Triggers, searches and actions
Use the tables below to inspect Mailchimp's 13 triggers, 61 search modules, and 91 actions.
Triggers
13 triggers fire automatically when specified events occur — no polling or cron job needed.
- Watch Automations
- Watch Campaign Feedback
- Watch Campaigns
- Watch Carts
- Watch Connected Sites
Searches
Fetch data on demand using 61 search modules that query the app during a run.
- Get a Campaign
- Get a Campaign Content
- Get a Campaign Feedback
- Get a Campaign Folder
- Get a Cart
Actions
91 action modules cover the full range of create, update, and delete operations.
- Archive a Contact
- Cancel a Campaign
- Cancel an SMS Campaign Send
- Create a Campaign
- Create a Campaign Feedback
Explore the fields available for each Mailchimp trigger, search, and action.
Triggers
| Field | Type |
|---|---|
ID | text |
Create time | date |
Start time | date |
Status | text |
Emails sent | number |
Recipients | object |
List ID | text |
List is active | boolean |
List name | text |
Segment opts | object |
Store ID | text |
Settings | object |
Title | text |
From name | text |
Reply to | text |
Use conversation | boolean |
To name | text |
Authenticate | boolean |
Auto footer | boolean |
Inline CSS | boolean |
| Field | Type |
|---|---|
Feedback ID | number |
Parent ID | number |
Block ID | number |
Message | text |
Is complete | boolean |
Created by | text |
Created at | date |
| Field | Type |
|---|---|
ID | text |
Web ID | number |
Parent campaign ID | text |
Type | text |
Create time | date |
Archive URL | url |
Long archive URL | url |
| Field | Type |
|---|---|
ID | text |
Customer | object |
ID | text |
Email address | |
Sms phone number | text |
Opt in status | boolean |
Company | text |
First name | text |
Last name | text |
Orders count | number |
Total spent | number |
Address | object |
Campaign ID | text |
Checkout URL | text |
Currency code | text |
Order total | number |
Tax total | number |
| Field | Type |
|---|---|
Foreign ID | text |
Store ID | text |
Platform | text |
Domain | text |
Site script | object |
URL | text |
Fragment | text |
Is pixel enabled | boolean |
Created at | date |
| Field | Type |
|---|---|
ID | text |
Audience ID | text |
Language | text |
Status | text |
Email channel | object |
Email | |
Hashed email | text |
Effective subscription status | object |
Marketing consent | object |
Source | object |
Sms channel | object |
Sms phone | text |
Hashed sms phone | text |
Effective subscription status | object |
Marketing consent | object |
Source | object |
Merge fields | object |
Property 1 | text |
Property 2 | text |
| Field | Type |
|---|---|
ID | text |
Email address | |
Sms phone number | text |
Opt in status | boolean |
Company | text |
First name | text |
Last name | text |
| Field | Type |
|---|---|
ID | text |
Name | text |
Title | text |
Description | text |
Template ID | number |
Status | text |
List ID | text |
| Field | Type |
|---|---|
ID | text |
Web ID | number |
Name | text |
Contact | object |
Company | text |
Address 1 | text |
Address 2 | text |
City | text |
State | text |
Zip | text |
Country | text |
Phone | text |
Permission reminder | text |
Use archive bar | boolean |
Campaign defaults | object |
From name | text |
From email | text |
Subject | text |
Language | text |
| Field | Type |
|---|---|
ID | text |
Customer | object |
ID | text |
Email address | |
Sms phone number | text |
Opt in status | boolean |
Company | text |
First name | text |
Last name | text |
Orders count | number |
Total spent | number |
Address | object |
Store ID | text |
Campaign ID | text |
Cart ID | text |
Landing site | url |
Financial status | text |
| Field | Type |
|---|---|
ID | text |
Web ID | text |
Name | text |
Status | text |
Channel | text |
List ID | number |
Recipient count | number |
| Field | Type |
|---|---|
ID | text |
List ID | text |
Name | text |
Platform | text |
Domain | text |
Is syncing | boolean |
Email address | text |
| Field | Type |
|---|---|
ID | number |
Type | text |
Name | text |
Drag and drop | boolean |
Responsive | boolean |
Category | text |
Date created | date |
Searches
| Field | Type |
|---|---|
Campaign IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Web ID | number |
Parent campaign ID | text |
Type | text |
Create time | date |
Archive URL | url |
Long archive URL | url |
| Field | Type |
|---|---|
Campaign IDRequired | choice |
| Field | Type |
|---|---|
Variate contents | array |
Plain text | text |
HTML | text |
Archive HTML | text |
links | array |
| Field | Type |
|---|---|
Campaign IDRequired | choice |
| Field | Type |
|---|---|
Feedback ID | number |
Parent ID | number |
Block ID | number |
Message | text |
Is complete | boolean |
Created by | text |
Created at | date |
| Field | Type |
|---|---|
Folder IDRequired | choice |
| Field | Type |
|---|---|
Name | text |
ID | text |
Count | number |
links | array |
| Field | Type |
|---|---|
Store IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Customer | object |
ID | text |
Email address | text |
Sms phone number | text |
Opt in status | boolean |
Company | text |
First name | text |
Last name | text |
Orders count | number |
Total spent | number |
Address | object |
Campaign ID | text |
Checkout URL | text |
Currency code | text |
Order total | number |
Tax total | number |
| Field | Type |
|---|---|
Store IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Product ID | text |
Product title | text |
Product variant ID | text |
Product variant title | text |
Quantity | number |
Price | number |
| Field | Type |
|---|---|
Connected Site IDRequired | choice |
| Field | Type |
|---|---|
Foreign ID | text |
Store ID | text |
Platform | text |
Domain | text |
Site script | object |
URL | text |
Fragment | text |
Is pixel enabled | boolean |
Created at | date |
| Field | Type |
|---|---|
Audience IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Audience ID | text |
Language | text |
Status | text |
Email channel | object |
Email | |
Hashed email | text |
Effective subscription status | object |
Marketing consent | object |
Source | object |
Sms channel | object |
Sms phone | text |
Hashed sms phone | text |
Effective subscription status | object |
Marketing consent | object |
Source | object |
Merge fields | object |
Property 1 | text |
Property 2 | text |
| Field | Type |
|---|---|
Conversation IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Message count | number |
Campaign ID | text |
List ID | text |
Unread messages | number |
From label | text |
From email | text |
| Field | Type |
|---|---|
Store IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Email address | |
Sms phone number | text |
Opt in status | boolean |
Company | text |
First name | text |
Last name | text |
| Field | Type |
|---|---|
Domain NameRequired | choice |
| Field | Type |
|---|---|
Domain | text |
Verified | boolean |
Authenticated | boolean |
Verification email | |
Verification sent | date |
Status | text |
Is free email provider | boolean |
| Field | Type |
|---|---|
Page IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Name | text |
Title | text |
Description | text |
Template ID | number |
Status | text |
List ID | text |
| Field | Type |
|---|---|
Page IDRequired | choice |
| Field | Type |
|---|---|
HTML | text |
JSON | text |
links | array |
| Field | Type |
|---|---|
List IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Web ID | number |
Name | text |
Contact | object |
Company | text |
Address 1 | text |
Address 2 | text |
City | text |
State | text |
Zip | text |
Country | text |
Phone | text |
Permission reminder | text |
Use archive bar | boolean |
Campaign defaults | object |
From name | text |
From email | text |
Subject | text |
Language | text |
| Field | Type |
|---|---|
Conversation IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Conversation ID | text |
List ID | number |
From label | text |
From email | |
Subject | text |
Message | text |
| Field | Type |
|---|---|
Export IDRequired | choice |
| Field | Type |
|---|---|
Export ID | number |
Started | date |
Finished | date |
Size in bytes | number |
Download URL | url |
links | array |
| Field | Type |
|---|---|
Audience IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Name | text |
Stats | object |
Total contacts | number |
Enabled channels | array |
| Field | Type |
|---|---|
Automation IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Create time | date |
Start time | date |
Status | text |
Emails sent | number |
Recipients | object |
List ID | text |
List is active | boolean |
List name | text |
Segment opts | object |
Store ID | text |
Settings | object |
Title | text |
From name | text |
Reply to | text |
Use conversation | boolean |
To name | text |
Authenticate | boolean |
Auto footer | boolean |
Inline CSS | boolean |
| Field | Type |
|---|---|
Store IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Customer | object |
ID | text |
Email address | |
Sms phone number | text |
Opt in status | boolean |
Company | text |
First name | text |
Last name | text |
Orders count | number |
Total spent | number |
Address | object |
Store ID | text |
Campaign ID | text |
Cart ID | text |
Landing site | url |
Financial status | text |
| Field | Type |
|---|---|
Store IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Product ID | text |
Product title | text |
Product variant ID | text |
Product variant title | text |
Image URL | text |
Quantity | number |
| Field | Type |
|---|---|
SMS Campaign IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Web ID | text |
Name | text |
Status | text |
Channel | text |
List ID | number |
Recipient count | number |
| Field | Type |
|---|---|
SMS Campaign IDRequired | choice |
| Field | Type |
|---|---|
Message body | text |
Estimated segments | number |
Merge fields | array |
Media | array |
Source | object |
Type | text |
ID | text |
Properties | object |
Content type | text |
Sender | text |
Optout message language | text |
links | array |
| Field | Type |
|---|---|
Store IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Currency code | text |
Title | text |
Handle | text |
URL | text |
Description | text |
Type | text |
| Field | Type |
|---|---|
Store IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
URL | url |
Variant ids | array |
links | array |
| Field | Type |
|---|---|
Store IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Title | text |
URL | text |
Sku | text |
Price | number |
Inventory quantity | number |
Image URL | text |
| Field | Type |
|---|---|
Store IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Code | text |
Redemption URL | text |
Usage count | number |
Enabled | text |
Created at foreign | date |
Updated at foreign | date |
| Field | Type |
|---|---|
Store IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Title | text |
Description | text |
Starts at | date |
Ends at | date |
Amount | number |
Type | text |
| Field | Type |
|---|---|
Store IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
List ID | text |
Name | text |
Platform | text |
Domain | text |
Is syncing | boolean |
Email address | text |
| Field | Type |
|---|---|
Template IDRequired | choice |
| Field | Type |
|---|---|
ID | number |
Type | text |
Name | text |
Drag and drop | boolean |
Responsive | boolean |
Category | text |
Date created | date |
| Field | Type |
|---|---|
Folder IDRequired | choice |
| Field | Type |
|---|---|
Name | text |
ID | text |
Count | number |
links | array |
| Field | Type |
|---|---|
Workflow IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Web ID | number |
Workflow ID | text |
Position | number |
Delay | object |
Amount | number |
Type | text |
Direction | text |
Action | text |
Action description | text |
Full description | text |
Create time | date |
Start time | date |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Export ID | number |
Started | date |
Finished | date |
Size in bytes | number |
Download URL | url |
links | array |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
Name | text |
Stats | object |
Total contacts | number |
Enabled channels | array |
| Field | Type |
|---|---|
Automation IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Web ID | number |
Workflow ID | text |
Position | number |
Delay | object |
Amount | number |
Type | text |
Direction | text |
Action | text |
Action description | text |
Full description | text |
Create time | date |
Start time | date |
| Field | Type |
|---|---|
Workflow IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Workflow ID | text |
Email ID | text |
List ID | text |
Email address | |
Next send | date |
links | array |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
Create time | date |
Start time | date |
Status | text |
Emails sent | number |
Recipients | object |
List ID | text |
List is active | boolean |
List name | text |
Segment opts | object |
Store ID | text |
Settings | object |
Title | text |
From name | text |
Reply to | text |
Use conversation | boolean |
To name | text |
Authenticate | boolean |
Auto footer | boolean |
Inline CSS | boolean |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
Status | text |
Total operations | number |
Finished operations | number |
Errored operations | number |
Submitted at | date |
Completed at | date |
| Field | Type |
|---|---|
Campaign IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Feedback ID | number |
Parent ID | number |
Block ID | number |
Message | text |
Is complete | boolean |
Created by | text |
Created at | date |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Name | text |
ID | text |
Count | number |
links | array |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
Web ID | number |
Parent campaign ID | text |
Type | text |
Create time | date |
Archive URL | url |
Long archive URL | url |
| Field | Type |
|---|---|
Store IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Product ID | text |
Product title | text |
Product variant ID | text |
Product variant title | text |
Quantity | number |
Price | number |
| Field | Type |
|---|---|
Store IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Customer | object |
ID | text |
Email address | |
Sms phone number | text |
Opt in status | boolean |
Company | text |
First name | text |
Last name | text |
Orders count | number |
Total spent | number |
Address | object |
Campaign ID | text |
Checkout URL | text |
Currency code | text |
Order total | number |
Tax total | number |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Foreign ID | text |
Store ID | text |
Platform | text |
Domain | text |
Site script | object |
URL | text |
Fragment | text |
Is pixel enabled | boolean |
Created at | date |
| Field | Type |
|---|---|
Audience IDRequired | choice |
Created Before | date |
Created Since | date |
Updated Before | date |
Updated Since | date |
Sort Field | choice |
Sort Direction | choice |
| Field | Type |
|---|---|
ID | text |
Audience ID | text |
Language | text |
Status | text |
Email channel | object |
Email | |
Hashed email | text |
Effective subscription status | object |
Marketing consent | object |
Source | object |
Sms channel | object |
Sms phone | text |
Hashed sms phone | text |
Effective subscription status | object |
Marketing consent | object |
Source | object |
Merge fields | object |
Property 1 | text |
Property 2 | text |
| Field | Type |
|---|---|
List IDRequired | choice |
Campaign IDRequired | choice |
Has Unread Messages | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Message count | number |
Campaign ID | text |
List ID | text |
Unread messages | number |
From label | text |
From email | text |
| Field | Type |
|---|---|
Store IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Email address | |
Sms phone number | text |
Opt in status | boolean |
Company | text |
First name | text |
Last name | text |
| Field | Type |
|---|---|
Order DirectionRequired | choice |
Sort FieldRequired | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Web ID | number |
Name | text |
Contact | object |
Company | text |
Address 1 | text |
Address 2 | text |
City | text |
State | text |
Zip | text |
Country | text |
Phone | text |
Permission reminder | text |
Use archive bar | boolean |
Campaign defaults | object |
From name | text |
From email | text |
Subject | text |
Language | text |
| Field | Type |
|---|---|
Order DirectionRequired | choice |
Sort FieldRequired | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Name | text |
Title | text |
Description | text |
Template ID | number |
Status | text |
List ID | text |
| Field | Type |
|---|---|
Conversation IDRequired | choice |
Is Read | choice |
Before Timestamp | date |
Since Timestamp | date |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Message count | number |
Campaign ID | text |
List ID | text |
Unread messages | number |
From label | text |
From email | text |
| Field | Type |
|---|---|
Store IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Product ID | text |
Product title | text |
Product variant ID | text |
Product variant title | text |
Image URL | text |
Quantity | number |
| Field | Type |
|---|---|
Store IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Customer | object |
ID | text |
Email address | |
Sms phone number | text |
Opt in status | boolean |
Company | text |
First name | text |
Last name | text |
Orders count | number |
Total spent | number |
Address | object |
Store ID | text |
Campaign ID | text |
Cart ID | text |
Landing site | url |
Financial status | text |
| Field | Type |
|---|---|
Store IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
URL | url |
Variant ids | array |
links | array |
| Field | Type |
|---|---|
Store IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Currency code | text |
Title | text |
Handle | text |
URL | text |
Description | text |
Type | text |
| Field | Type |
|---|---|
Store IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Title | text |
URL | text |
Sku | text |
Price | number |
Inventory quantity | number |
Image URL | text |
| Field | Type |
|---|---|
Store IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Code | text |
Redemption URL | text |
Usage count | number |
Enabled | text |
Created at foreign | date |
Updated at foreign | date |
| Field | Type |
|---|---|
Store IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Title | text |
Description | text |
Starts at | date |
Ends at | date |
Amount | number |
Type | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
Web ID | text |
Name | text |
Status | text |
Channel | text |
List ID | number |
Recipient count | number |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
List ID | text |
Name | text |
Platform | text |
Domain | text |
Is syncing | boolean |
Email address | text |
| Field | Type |
|---|---|
Store IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Name | text |
ID | text |
Count | number |
links | array |
| Field | Type |
|---|---|
Created By | choice |
Since Date Created | date |
Before Date Created | date |
Type | text |
Category | text |
Folder ID | choice |
Sort Field | choice |
| Field | Type |
|---|---|
ID | number |
Type | text |
Name | text |
Drag and drop | boolean |
Responsive | boolean |
Category | text |
Date created | date |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Domain | text |
Verified | boolean |
Authenticated | boolean |
Verification email | |
Verification sent | date |
Status | text |
Is free email provider | boolean |
Actions
| Field | Type |
|---|---|
Audience IDRequired | choice |
| Field | Type |
|---|---|
Campaign IDRequired | choice |
| Field | Type |
|---|---|
SMS Campaign IDRequired | choice |
| Field | Type |
|---|---|
TypeRequired | choice |
Feed URLRequired | url |
FrequencyRequired | choice |
List IDRequired | text |
Winner CriteriaRequired | choice |
RSS Options | object |
Schedule | object |
Constrain RSS Image | boolean |
Recipients | object |
Segment Options | object |
| Field | Type |
|---|---|
ID | text |
Web ID | number |
Parent campaign ID | text |
Type | text |
Create time | date |
Archive URL | url |
Long archive URL | url |
| Field | Type |
|---|---|
Campaign IDRequired | choice |
MessageRequired | text |
Block ID | choice |
Is Complete | boolean |
| Field | Type |
|---|---|
Feedback ID | number |
Parent ID | number |
Block ID | number |
Message | text |
Is complete | boolean |
Created by | text |
Created at | date |
| Field | Type |
|---|---|
NameRequired | text |
| Field | Type |
|---|---|
Name | text |
ID | text |
Count | number |
links | array |
| Field | Type |
|---|---|
Store IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Customer | object |
ID | text |
Email address | text |
Sms phone number | text |
Opt in status | boolean |
Company | text |
First name | text |
Last name | text |
Orders count | number |
Total spent | number |
Address | object |
Campaign ID | text |
Checkout URL | text |
Currency code | text |
Order total | number |
Tax total | number |
| Field | Type |
|---|---|
Store IDRequired | choice |
IDRequired | text |
QuantityRequired | number |
PriceRequired | number |
| Field | Type |
|---|---|
ID | text |
Product ID | text |
Product title | text |
Product variant ID | text |
Product variant title | text |
Quantity | number |
Price | number |
| Field | Type |
|---|---|
Foreign IDRequired | text |
DomainRequired | text |
| Field | Type |
|---|---|
Foreign ID | text |
Store ID | text |
Platform | text |
Domain | text |
Site script | object |
URL | text |
Fragment | text |
Is pixel enabled | boolean |
Created at | date |
| Field | Type |
|---|---|
Audience IDRequired | choice |
Merge Field Validation Mode | choice |
Data Mode | choice |
Language | choice |
Email Channel | object |
Email | |
Marketing Consent | object |
Source | object |
Name | text |
SMS Channel | object |
SMS Phone | text |
Marketing Consent | object |
Source | object |
| Field | Type |
|---|---|
ID | text |
Audience ID | text |
Language | text |
Status | text |
Email channel | object |
Email | |
Hashed email | text |
Effective subscription status | object |
Marketing consent | object |
Source | object |
Sms channel | object |
Sms phone | text |
Hashed sms phone | text |
Effective subscription status | object |
Marketing consent | object |
Source | object |
Merge fields | object |
Property 1 | text |
Property 2 | text |
| Field | Type |
|---|---|
Store IDRequired | choice |
IDRequired | text |
Opt-in StatusRequired | boolean |
Email Address | |
SMS Phone Number | text |
Company | text |
First Name | text |
| Field | Type |
|---|---|
ID | text |
Email address | |
Sms phone number | text |
Opt in status | boolean |
Company | text |
First name | text |
Last name | text |
| Field | Type |
|---|---|
Verification EmailRequired |
| Field | Type |
|---|---|
Domain | text |
Verified | boolean |
Authenticated | boolean |
Verification email | |
Verification sent | date |
Status | text |
Is free email provider | boolean |
| Field | Type |
|---|---|
Landing Page NameRequired | text |
Landing Page TitleRequired | text |
Store IDRequired | choice |
List IDRequired | choice |
Template TypeRequired | choice |
Use Default List | boolean |
Description | text |
| Field | Type |
|---|---|
ID | text |
Name | text |
Title | text |
Description | text |
Template ID | number |
Status | text |
List ID | text |
| Field | Type |
|---|---|
NameRequired | text |
ContactRequired | object |
CompanyRequired | text |
Address 1Required | text |
CityRequired | text |
CountryRequired | text |
Address 2 | text |
State | text |
Zip | text |
Phone | text |
Permission ReminderRequired | text |
Campaign DefaultsRequired | object |
From NameRequired | text |
From EmailRequired | |
SubjectRequired | text |
LanguageRequired | text |
Email Type OptionRequired | boolean |
Use Archive Bar | boolean |
Notify On Subscribe |
| Field | Type |
|---|---|
ID | text |
Web ID | number |
Name | text |
Contact | object |
Company | text |
Address 1 | text |
Address 2 | text |
City | text |
State | text |
Zip | text |
Country | text |
Phone | text |
Permission reminder | text |
Use archive bar | boolean |
Campaign defaults | object |
From name | text |
From email | text |
Subject | text |
Language | text |
| Field | Type |
|---|---|
Include StagesRequired | array |
Stage | text |
Since Timestamp | date |
| Field | Type |
|---|---|
Export ID | number |
Started | date |
Finished | date |
Size in bytes | number |
Download URL | url |
links | array |
| Field | Type |
|---|---|
RecipientsRequired | object |
List ID | choice |
Store ID | choice |
Trigger SettingsRequired | object |
Workflow TypeRequired | text |
Settings | object |
From Name | text |
Reply To |
| Field | Type |
|---|---|
ID | text |
Create time | date |
Start time | date |
Status | text |
Emails sent | number |
Recipients | object |
List ID | text |
List is active | boolean |
List name | text |
Segment opts | object |
Store ID | text |
Settings | object |
Title | text |
From name | text |
Reply to | text |
Use conversation | boolean |
To name | text |
Authenticate | boolean |
Auto footer | boolean |
Inline CSS | boolean |
| Field | Type |
|---|---|
Store IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Customer | object |
ID | text |
Email address | |
Sms phone number | text |
Opt in status | boolean |
Company | text |
First name | text |
Last name | text |
Orders count | number |
Total spent | number |
Address | object |
Store ID | text |
Campaign ID | text |
Cart ID | text |
Landing site | url |
Financial status | text |
| Field | Type |
|---|---|
Store IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Product ID | text |
Product title | text |
Product variant ID | text |
Product variant title | text |
Image URL | text |
Quantity | number |
| Field | Type |
|---|---|
NameRequired | text |
List IDRequired | choice |
Folder ID | choice |
Segments | choice |
Excluded Segments | choice |
| Field | Type |
|---|---|
ID | text |
Web ID | text |
Name | text |
Status | text |
Channel | text |
List ID | number |
Recipient count | number |
| Field | Type |
|---|---|
Store IDRequired | choice |
IDRequired | text |
TitleRequired | text |
VariantsRequired | array |
Handle | text |
URL | url |
Description | text |
| Field | Type |
|---|---|
ID | text |
Currency code | text |
Title | text |
Handle | text |
URL | text |
Description | text |
Type | text |
| Field | Type |
|---|---|
Store IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
URL | url |
Variant ids | array |
links | array |
| Field | Type |
|---|---|
Store IDRequired | choice |
IDRequired | text |
TitleRequired | text |
URL | url |
SKU | text |
Price | number |
Inventory Quantity | number |
| Field | Type |
|---|---|
ID | text |
Title | text |
URL | text |
Sku | text |
Price | number |
Inventory quantity | number |
Image URL | text |
| Field | Type |
|---|---|
Store IDRequired | choice |
Promo Code IDRequired | text |
Discount CodeRequired | text |
Redemption URLRequired | url |
Usage Count | number |
Enabled | boolean |
Updated At Foreign | date |
| Field | Type |
|---|---|
ID | text |
Code | text |
Redemption URL | text |
Usage count | number |
Enabled | text |
Created at foreign | date |
Updated at foreign | date |
| Field | Type |
|---|---|
Store IDRequired | choice |
Promo Rule IDRequired | text |
DescriptionRequired | text |
AmountRequired | number |
TypeRequired | choice |
TargetRequired | choice |
Title | text |
| Field | Type |
|---|---|
ID | text |
Title | text |
Description | text |
Starts at | date |
Ends at | date |
Amount | number |
Type | text |
| Field | Type |
|---|---|
Store IDRequired | text |
List IDRequired | choice |
Store NameRequired | text |
Currency CodeRequired | text |
Domain | url |
Platform | text |
Is Syncing | boolean |
| Field | Type |
|---|---|
ID | text |
List ID | text |
Name | text |
Platform | text |
Domain | text |
Is syncing | boolean |
Email address | text |
| Field | Type |
|---|---|
NameRequired | text |
HTMLRequired | text |
Folder ID | choice |
| Field | Type |
|---|---|
ID | number |
Type | text |
Name | text |
Drag and drop | boolean |
Responsive | boolean |
Category | text |
Date created | date |
| Field | Type |
|---|---|
NameRequired | text |
| Field | Type |
|---|---|
Name | text |
ID | text |
Count | number |
links | array |
| Field | Type |
|---|---|
Campaign IDRequired | choice |
| Field | Type |
|---|---|
Folder IDRequired | choice |
| Field | Type |
|---|---|
Store IDRequired | choice |
| Field | Type |
|---|---|
Store IDRequired | choice |
| Field | Type |
|---|---|
Connected Site IDRequired | choice |
| Field | Type |
|---|---|
Store IDRequired | choice |
| Field | Type |
|---|---|
Domain NameRequired | choice |
| Field | Type |
|---|---|
Page IDRequired | choice |
| Field | Type |
|---|---|
List IDRequired | choice |
| Field | Type |
|---|---|
Store IDRequired | choice |
| Field | Type |
|---|---|
Store IDRequired | choice |
| Field | Type |
|---|---|
SMS Campaign IDRequired | choice |
| Field | Type |
|---|---|
Store IDRequired | choice |
| Field | Type |
|---|---|
Store IDRequired | choice |
| Field | Type |
|---|---|
Store IDRequired | choice |
| Field | Type |
|---|---|
Store IDRequired | choice |
| Field | Type |
|---|---|
Store IDRequired | choice |
| Field | Type |
|---|---|
Store IDRequired | choice |
| Field | Type |
|---|---|
Template IDRequired | choice |
| Field | Type |
|---|---|
Folder IDRequired | choice |
| Field | Type |
|---|---|
Workflow IDRequired | choice |
| Field | Type |
|---|---|
Connected Site IDRequired | choice |
| Field | Type |
|---|---|
Connected Site IDRequired | choice |
| Field | Type |
|---|---|
Audience IDRequired | choice |
| Field | Type |
|---|---|
MethodRequired | choice |
Headers | array |
Header | object |
Query String | array |
Parameter | object |
Body | text |
| Field | Type |
|---|---|
Body | text |
Headers | object |
Status code | number |
| Field | Type |
|---|---|
Campaign IDRequired | choice |
| Field | Type |
|---|---|
Automation IDRequired | choice |
| Field | Type |
|---|---|
Workflow IDRequired | choice |
| Field | Type |
|---|---|
Page IDRequired | choice |
| Field | Type |
|---|---|
Campaign IDRequired | choice |
| Field | Type |
|---|---|
Campaign IDRequired | choice |
| Field | Type |
|---|---|
Campaign IDRequired | choice |
Schedule TimeRequired | time |
Batch Delivery | object |
Batch DelayRequired | number |
Batch CountRequired | number |
Timewarp | boolean |
| Field | Type |
|---|---|
Campaign IDRequired | choice |
| Field | Type |
|---|---|
SMS Campaign IDRequired | choice |
| Field | Type |
|---|---|
Campaign IDRequired | choice |
Send TypeRequired | choice |
Test EmailsRequired | array |
Email |
| Field | Type |
|---|---|
Campaign IDRequired | choice |
Archive | object |
Archive ContentRequired | text |
Archive Type | choice |
Template | object |
IDRequired | number |
Sections | object |
Plain Text | text |
HTML | text |
URL | url |
Variate Contents | array |
| Field | Type |
|---|---|
Variate contents | array |
Plain text | text |
HTML | text |
Archive HTML | text |
links | array |
| Field | Type |
|---|---|
SMS Campaign IDRequired | choice |
Message BodyRequired | text |
Media | array |
| Field | Type |
|---|---|
Message body | text |
Estimated segments | number |
Merge fields | array |
Media | array |
Source | object |
Type | text |
ID | text |
Properties | object |
Content type | text |
Sender | text |
Optout message language | text |
links | array |
| Field | Type |
|---|---|
Automation IDRequired | choice |
| Field | Type |
|---|---|
Workflow IDRequired | choice |
| Field | Type |
|---|---|
Page IDRequired | choice |
| Field | Type |
|---|---|
Campaign IDRequired | choice |
| Field | Type |
|---|---|
Campaign IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Web ID | number |
Parent campaign ID | text |
Type | text |
Create time | date |
Archive URL | url |
Long archive URL | url |
| Field | Type |
|---|---|
Campaign IDRequired | choice |
Message | text |
Block ID | choice |
Is Complete | boolean |
| Field | Type |
|---|---|
Feedback ID | number |
Parent ID | number |
Block ID | number |
Message | text |
Is complete | boolean |
Created by | text |
Created at | date |
| Field | Type |
|---|---|
Folder IDRequired | choice |
NameRequired | text |
| Field | Type |
|---|---|
Name | text |
ID | text |
Count | number |
links | array |
| Field | Type |
|---|---|
Store IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Customer | object |
ID | text |
Email address | text |
Sms phone number | text |
Opt in status | boolean |
Company | text |
First name | text |
Last name | text |
Orders count | number |
Total spent | number |
Address | object |
Campaign ID | text |
Checkout URL | text |
Currency code | text |
Order total | number |
Tax total | number |
| Field | Type |
|---|---|
Store IDRequired | choice |
Quantity | number |
Price | number |
| Field | Type |
|---|---|
ID | text |
Product ID | text |
Product title | text |
Product variant ID | text |
Product variant title | text |
Quantity | number |
Price | number |
| Field | Type |
|---|---|
Audience IDRequired | choice |
Merge Field Validation Mode | choice |
Data Mode | choice |
Language | choice |
Email Channel | object |
Email | |
Marketing Consent | object |
Source | object |
Name | text |
SMS Channel | object |
SMS Phone | text |
Marketing Consent | object |
Source | object |
| Field | Type |
|---|---|
ID | text |
Audience ID | text |
Language | text |
Status | text |
Email channel | object |
Email | |
Hashed email | text |
Effective subscription status | object |
Marketing consent | object |
Source | object |
Sms channel | object |
Sms phone | text |
Hashed sms phone | text |
Effective subscription status | object |
Marketing consent | object |
Source | object |
Merge fields | object |
Property 1 | text |
Property 2 | text |
| Field | Type |
|---|---|
Store IDRequired | choice |
Opt-in Status | boolean |
Email Address | |
SMS Phone Number | text |
Company | text |
First Name | text |
Last Name | text |
| Field | Type |
|---|---|
ID | text |
Email address | |
Sms phone number | text |
Opt in status | boolean |
Company | text |
First name | text |
Last name | text |
| Field | Type |
|---|---|
Page IDRequired | choice |
Landing Page Name | text |
Landing Page Title | text |
Store ID | choice |
List ID | choice |
Template Type | choice |
Use Default List | boolean |
| Field | Type |
|---|---|
ID | text |
Name | text |
Title | text |
Description | text |
Template ID | number |
Status | text |
List ID | text |
| Field | Type |
|---|---|
List IDRequired | choice |
Name | text |
Contact | object |
Company | text |
Address 1 | text |
City | text |
Country | text |
Address 2 | text |
State | text |
Zip | text |
Phone | text |
Permission Reminder | text |
Campaign Defaults | object |
From NameRequired | text |
From EmailRequired | |
SubjectRequired | text |
LanguageRequired | text |
Email Type OptionRequired | boolean |
Use Archive Bar | boolean |
| Field | Type |
|---|---|
ID | text |
Web ID | number |
Name | text |
Contact | object |
Company | text |
Address 1 | text |
Address 2 | text |
City | text |
State | text |
Zip | text |
Country | text |
Phone | text |
Permission reminder | text |
Use archive bar | boolean |
Campaign defaults | object |
From name | text |
From email | text |
Subject | text |
Language | text |
| Field | Type |
|---|---|
Store IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Customer | object |
ID | text |
Email address | |
Sms phone number | text |
Opt in status | boolean |
Company | text |
First name | text |
Last name | text |
Orders count | number |
Total spent | number |
Address | object |
Store ID | text |
Campaign ID | text |
Cart ID | text |
Landing site | url |
Financial status | text |
| Field | Type |
|---|---|
Store IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Product ID | text |
Product title | text |
Product variant ID | text |
Product variant title | text |
Image URL | text |
Quantity | number |
| Field | Type |
|---|---|
SMS Campaign IDRequired | choice |
Name | text |
List ID | choice |
Folder ID | choice |
Segments | choice |
Excluded Segments | choice |
| Field | Type |
|---|---|
ID | text |
Web ID | text |
Name | text |
Status | text |
Channel | text |
List ID | number |
Recipient count | number |
| Field | Type |
|---|---|
Store IDRequired | choice |
Title | text |
Variants | array |
Handle | text |
URL | url |
Description | text |
Type | text |
| Field | Type |
|---|---|
ID | text |
Currency code | text |
Title | text |
Handle | text |
URL | text |
Description | text |
Type | text |
| Field | Type |
|---|---|
Store IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
URL | url |
Variant ids | array |
links | array |
| Field | Type |
|---|---|
Store IDRequired | choice |
Title | text |
URL | url |
SKU | text |
Price | number |
Inventory Quantity | number |
Image URL | url |
| Field | Type |
|---|---|
ID | text |
Title | text |
URL | text |
Sku | text |
Price | number |
Inventory quantity | number |
Image URL | text |
| Field | Type |
|---|---|
Store IDRequired | choice |
Discount Code | text |
Redemption URL | url |
Usage Count | number |
Enabled | boolean |
Updated At Foreign | date |
Created At | date |
| Field | Type |
|---|---|
ID | text |
Code | text |
Redemption URL | text |
Usage count | number |
Enabled | text |
Created at foreign | date |
Updated at foreign | date |
| Field | Type |
|---|---|
Store IDRequired | choice |
Description | text |
Amount | number |
Type | choice |
Target | choice |
Title | text |
Starts At | date |
| Field | Type |
|---|---|
ID | text |
Title | text |
Description | text |
Starts at | date |
Ends at | date |
Amount | number |
Type | text |
| Field | Type |
|---|---|
Store IDRequired | choice |
List IDRequired | choice |
Store NameRequired | text |
Currency CodeRequired | text |
Domain | url |
Platform | text |
Is Syncing | boolean |
| Field | Type |
|---|---|
ID | text |
List ID | text |
Name | text |
Platform | text |
Domain | text |
Is syncing | boolean |
Email address | text |
| Field | Type |
|---|---|
Template IDRequired | choice |
Name | text |
HTML | text |
Folder ID | choice |
| Field | Type |
|---|---|
ID | number |
Type | text |
Name | text |
Drag and drop | boolean |
Responsive | boolean |
Category | text |
Date created | date |
| Field | Type |
|---|---|
Folder IDRequired | choice |
NameRequired | text |
| Field | Type |
|---|---|
Name | text |
ID | text |
Count | number |
links | array |
| Field | Type |
|---|---|
Workflow IDRequired | choice |
Delay | object |
ActionRequired | choice |
Amount | number |
Type | choice |
Direction | choice |
| Field | Type |
|---|---|
ID | text |
Web ID | number |
Workflow ID | text |
Position | number |
Delay | object |
Amount | number |
Type | text |
Direction | text |
Action | text |
Action description | text |
Full description | text |
Create time | date |
Start time | date |
| Field | Type |
|---|---|
Connected Site IDRequired | choice |
| Field | Type |
|---|---|
Domain NameRequired | choice |
| Field | Type |
|---|---|
Domain | text |
Verified | boolean |
Authenticated | boolean |
Verification email | |
Verification sent | date |
Status | text |
Is free email provider | boolean |



