About this integration
Connect Omnisend to sync contacts, manage campaigns, and automate email and SMS marketing. Use it from the workflow canvas with no custom glue script required.
This integration exposes 0 triggers, 27 search modules and 56 actions as workflow nodes. Authentication uses basic authentication.
How to connect
The credential form asks for API Key.
Prefer the interactive builder form? Open it on the app page.
Enter your credentials below. WEXTL stores them encrypted and uses them only to call the API on your behalf.
| Field | Type | Help |
|---|---|---|
API KeyRequired | password | API Key from Omnisend → Store Settings → API Keys. |
Use it in workflow automation
Add Add Tags to Contacts as a workflow step.
Triggers, searches and actions
Use the tables below to inspect Omnisend's 0 triggers, 27 search modules, and 56 actions.
Searches
Fetch data on demand using 27 search modules that query the app during a run.
- Get Automation
- Get Automation UTM
- Get Batch
- Get Batch Items
- Get Block UTM
Actions
56 action modules cover the full range of create, update, and delete operations.
- Add Tags to Contacts
- Cancel Campaign
- Connect Brand
- Copy Automation
- Copy Campaign
Explore the fields available for each Omnisend trigger, search, and action.
Searches
| Field | Type |
|---|---|
Automation IDRequired | text |
| Field | Type |
|---|---|
Automation ID | text |
Name | text |
Enabled | boolean |
Trigger | object |
Condition | object |
Audience Filter Group | object |
Inactivity Settings | object |
Blocks | text |
Exit Conditions | text |
Settings | text |
Brand ID | text |
Created At | date |
Updated At | date |
Enabled At | date |
Disabled At | date |
| Field | Type |
|---|---|
Automation IDRequired | text |
| Field | Type |
|---|---|
Blocks | array |
Block ID | text |
Tags | object |
| Field | Type |
|---|---|
Batch IDRequired | text |
| Field | Type |
|---|---|
Batch ID | text |
Status | text |
Endpoint | text |
Method | text |
Origin | text |
Total Count | number |
Finished Count | number |
Errors Count | number |
Event ID | text |
Created At | date |
Started At | date |
Ended At | date |
Successful Items | array |
Item | object |
Failed Items | array |
Item | object |
| Field | Type |
|---|---|
Batch IDRequired | text |
| Field | Type |
|---|---|
Batch ID | text |
Status | text |
Endpoint | text |
Method | text |
Origin | text |
Total Count | number |
Finished Count | number |
Errors Count | number |
Event ID | text |
Created At | date |
Started At | date |
Ended At | date |
Successful Items | array |
Item | object |
Failed Items | array |
Item | object |
| Field | Type |
|---|---|
Automation IDRequired | text |
Block IDRequired | text |
| Field | Type |
|---|---|
Tags | object |
Source | text |
Medium | text |
Campaign | text |
| Field | Type |
|---|---|
Campaign IDRequired | text |
| Field | Type |
|---|---|
Campaign ID | text |
Name | text |
Type | text |
Channel | text |
Status | text |
Language | text |
Brand ID | text |
Content | object |
Email content | object |
SMS content | object |
Audience | object |
Included segment IDs | array |
Excluded segment IDs | array |
Sending settings | object |
Strategy | text |
Scheduled at | date |
Optimize for | text |
Timezone optimization enabled | boolean |
Booster settings | object |
Parent campaign ID | text |
Send to | text |
Delay | object |
A/B test | object |
Settings | object |
Variants | object |
Result | object |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
Campaign IDRequired | text |
| Field | Type |
|---|---|
Tags | object |
Source | text |
Medium | text |
Campaign | text |
Variants | object |
Variant A | object |
Variant B | object |
| Field | Type |
|---|---|
Contact IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
First Name | text |
Last Name | text |
Email | text |
Phone | array |
Phone Number | text |
Status | text |
Channel Statuses | array |
Channel | text |
Status | text |
Status Changed At | date |
Tags | array |
Tag | text |
Segments | array |
Segment ID | text |
Custom Properties | text |
Address | text |
City | text |
State | text |
Postal Code | text |
| Field | Type |
|---|---|
ID | text |
Name | text |
Website | url |
Currency | text |
| Field | Type |
|---|---|
Email Content IDRequired | text |
| Field | Type |
|---|---|
ID | text |
Sections | text |
General Settings | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Template IDRequired | text |
| Field | Type |
|---|---|
ID | text |
Name | text |
Content | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
ImageRequired | choice |
| Field | Type |
|---|---|
ID | text |
Name | text |
URL | url |
MIME Type | text |
Width | number |
Height | number |
Size (Bytes) | number |
Created At | date |
| Field | Type |
|---|---|
Product IDRequired | text |
| Field | Type |
|---|---|
Id | text |
Title | text |
Url | text |
Currency | text |
Status | text |
Description | text |
Default Image Url | text |
Images | array |
Image Url | text |
Tags | array |
Tag | text |
Type | text |
Vendor | text |
Category Ids | array |
Category Id | text |
Variants | array |
Variant | object |
Created At | date |
| Field | Type |
|---|---|
Category IDRequired | choice |
| Field | Type |
|---|---|
Category Id | text |
Title | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Segment IDRequired | choice |
| Field | Type |
|---|---|
Segment ID | text |
Name | text |
Status | text |
Is Starred | boolean |
Condition Groups | array |
Archived At | date |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Segment IDRequired | choice |
| Field | Type |
|---|---|
Segment ID | text |
Contacts Count | number |
| Field | Type |
|---|---|
Layout IDRequired | text |
| Field | Type |
|---|---|
ID | text |
Name | text |
Content | text |
Snapshot State | text |
Snapshot URL | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Limit | number |
After | text |
Before | text |
Sort | choice |
Direction | choice |
Is Enabled | boolean |
Name Contains | text |
Created At From | date |
Created At To | date |
Updated At From | date |
Updated At To | date |
| Field | Type |
|---|---|
Automation ID | text |
Name | text |
Enabled | boolean |
Trigger | object |
Condition | object |
Audience Filter Group | object |
Inactivity Settings | object |
Blocks | text |
Exit Conditions | text |
Settings | text |
Brand ID | text |
Created At | date |
Updated At | date |
Enabled At | date |
Disabled At | date |
| Field | Type |
|---|---|
EndpointRequired | choice |
Offset | number |
Limit | number |
Status | choice |
Date From | date |
Date To | date |
| Field | Type |
|---|---|
Batch ID | text |
Status | text |
Endpoint | text |
Method | text |
Origin | text |
Total Count | number |
Finished Count | number |
Errors Count | number |
Event ID | text |
Created At | date |
Started At | date |
Ended At | date |
Successful Items | array |
Item | object |
Failed Items | array |
Item | object |
| Field | Type |
|---|---|
Limit | number |
After | text |
Before | text |
Name Contains | text |
Status | choice |
Channel | choice |
Type | choice |
Parent Campaign ID | text |
Created At From | date |
Created At To | date |
Updated At From | date |
Updated At To | date |
Sort | choice |
Direction | choice |
| Field | Type |
|---|---|
Campaign ID | text |
Name | text |
Type | text |
Channel | text |
Status | text |
Language | text |
Brand ID | text |
Content | object |
Email content | object |
SMS content | object |
Audience | object |
Included segment IDs | array |
Excluded segment IDs | array |
Sending settings | object |
Strategy | text |
Scheduled at | date |
Optimize for | text |
Timezone optimization enabled | boolean |
Booster settings | object |
Parent campaign ID | text |
Send to | text |
Delay | object |
A/B test | object |
Settings | object |
Variants | object |
Result | object |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
Limit | number |
After Cursor | text |
Before Cursor | text |
Sort Field | choice |
Sort Direction | choice |
Email | text |
Phone | text |
Status | choice |
Segment | choice |
Tag | text |
Updated At From | date |
| Field | Type |
|---|---|
ID | text |
First Name | text |
Last Name | text |
Email | text |
Phone | array |
Phone Number | text |
Status | text |
Channel Statuses | array |
Channel | text |
Status | text |
Status Changed At | date |
Tags | array |
Tag | text |
Segments | array |
Segment ID | text |
Custom Properties | text |
Address | text |
City | text |
State | text |
Postal Code | text |
| Field | Type |
|---|---|
Limit | number |
After Cursor | text |
Before Cursor | text |
Sort Field | choice |
Sort Direction | choice |
Name Contains | text |
| Field | Type |
|---|---|
ID | text |
Name | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Limit | number |
After Cursor | text |
Before Cursor | text |
Sort Field | choice |
Sort Direction | choice |
Name Contains | text |
| Field | Type |
|---|---|
ID | text |
Name | text |
URL | url |
MIME Type | text |
Width | number |
Height | number |
Size (Bytes) | number |
Created At | date |
| Field | Type |
|---|---|
Limit | number |
Offset | number |
Sort By | choice |
| Field | Type |
|---|---|
Category Id | text |
Title | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Limit | number |
Offset | number |
Sort By | choice |
Title Contains | text |
| Field | Type |
|---|---|
Id | text |
Title | text |
Url | text |
Currency | text |
Status | text |
Description | text |
Default Image Url | text |
Images | array |
Image Url | text |
Tags | array |
Tag | text |
Type | text |
Vendor | text |
Category Ids | array |
Category Id | text |
Variants | array |
Variant | object |
Created At | date |
| Field | Type |
|---|---|
Limit | number |
After | text |
Before | text |
Sort Field | choice |
Sort Direction | choice |
| Field | Type |
|---|---|
Segment ID | text |
Name | text |
Status | text |
Is Starred | boolean |
Condition Groups | array |
Archived At | date |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Limit | number |
After Cursor | text |
Before Cursor | text |
Name Contains | text |
| Field | Type |
|---|---|
ID | text |
Name | text |
Content | text |
Snapshot State | text |
Snapshot URL | text |
Created At | date |
Updated At | date |
Actions
| Field | Type |
|---|---|
TagsRequired | array |
Tag | text |
Contact IDs | choice |
Emails | array |
Email | |
Phones | array |
Phone Number | text |
Segment | choice |
| Field | Type |
|---|---|
Campaign IDRequired | text |
| Field | Type |
|---|---|
Campaign ID | text |
Name | text |
Type | text |
Channel | text |
Status | text |
Language | text |
Brand ID | text |
Content | object |
Email content | object |
SMS content | object |
Audience | object |
Included segment IDs | array |
Excluded segment IDs | array |
Sending settings | object |
Strategy | text |
Scheduled at | date |
Optimize for | text |
Timezone optimization enabled | boolean |
Booster settings | object |
Parent campaign ID | text |
Send to | text |
Delay | object |
A/B test | object |
Settings | object |
Variants | object |
Result | object |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
PlatformRequired | text |
VersionRequired | text |
WebsiteRequired | url |
Currency | text |
| Field | Type |
|---|---|
Automation IDRequired | text |
Name | text |
| Field | Type |
|---|---|
Automation ID | text |
Name | text |
Enabled | boolean |
Trigger | object |
Condition | object |
Audience Filter Group | object |
Inactivity Settings | object |
Blocks | text |
Exit Conditions | text |
Settings | text |
Brand ID | text |
Created At | date |
Updated At | date |
Enabled At | date |
Disabled At | date |
| Field | Type |
|---|---|
Campaign IDRequired | text |
| Field | Type |
|---|---|
Campaign ID | text |
Name | text |
Type | text |
Channel | text |
Status | text |
Language | text |
Brand ID | text |
Content | object |
Email content | object |
SMS content | object |
Audience | object |
Included segment IDs | array |
Excluded segment IDs | array |
Sending settings | object |
Strategy | text |
Scheduled at | date |
Optimize for | text |
Timezone optimization enabled | boolean |
Booster settings | object |
Parent campaign ID | text |
Send to | text |
Delay | object |
A/B test | object |
Settings | object |
Variants | object |
Result | object |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
NameRequired | text |
Trigger | object |
Condition | object |
Audience Filter Group | object |
Inactivity Settings | object |
Blocks | text |
Exit Conditions | text |
| Field | Type |
|---|---|
Automation ID | text |
Name | text |
Enabled | boolean |
Trigger | object |
Condition | object |
Audience Filter Group | object |
Inactivity Settings | object |
Blocks | text |
Exit Conditions | text |
Settings | text |
Brand ID | text |
Created At | date |
Updated At | date |
Enabled At | date |
Disabled At | date |
| Field | Type |
|---|---|
EndpointRequired | choice |
MethodRequired | choice |
ItemsRequired | text |
Origin | text |
| Field | Type |
|---|---|
Batch ID | text |
Total Count | number |
| Field | Type |
|---|---|
TypeRequired | choice |
ChannelRequired | choice |
Name | text |
Language | text |
Content | object |
Email | object |
SMS | object |
Audience | object |
Included Segment IDs | choice |
Excluded Segment IDs | choice |
Sending Settings | object |
Strategy | choice |
Scheduled At | date |
Optimize For | choice |
Enable Timezone Optimization | boolean |
Booster Settings | object |
Parent CampaignRequired | choice |
Send ToRequired | choice |
Delay | object |
A/B Test | object |
SettingsRequired | object |
VariantsRequired | object |
| Field | Type |
|---|---|
Campaign ID | text |
Name | text |
Type | text |
Channel | text |
Status | text |
Language | text |
Brand ID | text |
Content | object |
Email content | object |
SMS content | object |
Audience | object |
Included segment IDs | array |
Excluded segment IDs | array |
Sending settings | object |
Strategy | text |
Scheduled at | date |
Optimize for | text |
Timezone optimization enabled | boolean |
Booster settings | object |
Parent campaign ID | text |
Send to | text |
Delay | object |
A/B test | object |
Settings | object |
Variants | object |
Result | object |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
NameRequired | text |
OriginRequired | text |
Display NameRequired | text |
PropertiesRequired | text |
| Field | Type |
|---|---|
Event | object |
Name | text |
Display Name | text |
Origins | array |
Explicitly Defined | boolean |
Properties | text |
| Field | Type |
|---|---|
NameRequired | text |
ContentRequired | text |
| Field | Type |
|---|---|
ID | text |
Name | text |
Content | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Identifiers | array |
Identifier | object |
First Name | text |
Last Name | text |
Tags | array |
Tag | text |
Custom Properties | text |
Birthdate | date |
Address | text |
City | text |
Country | text |
Country Code | text |
Gender | choice |
Postal Code | text |
State | text |
Tracking Consents | object |
Email Open | object |
| Field | Type |
|---|---|
ID | text |
First Name | text |
Last Name | text |
Email | text |
Phone | array |
Phone Number | text |
Status | text |
Channel Statuses | array |
Channel | text |
Status | text |
Status Changed At | date |
Tags | array |
Tag | text |
Segments | array |
Segment ID | text |
Custom Properties | text |
Address | text |
City | text |
State | text |
Postal Code | text |
| Field | Type |
|---|---|
Product IDRequired | text |
TitleRequired | text |
URLRequired | text |
CurrencyRequired | text |
StatusRequired | choice |
Description | text |
Default Image URL | text |
Images | array |
Image URL | text |
Tags | array |
Tag | text |
Type | text |
Vendor | text |
Category IDs | choice |
Variants | array |
Variant | object |
| Field | Type |
|---|---|
Id | text |
Title | text |
Url | text |
Currency | text |
Status | text |
Description | text |
Default Image Url | text |
Images | array |
Image Url | text |
Tags | array |
Tag | text |
Type | text |
Vendor | text |
Category Ids | array |
Category Id | text |
Variants | array |
Variant | object |
Created At | date |
| Field | Type |
|---|---|
Category IDRequired | text |
TitleRequired | text |
| Field | Type |
|---|---|
Category Id | text |
| Field | Type |
|---|---|
NameRequired | text |
Condition GroupsRequired | array |
Condition Group | object |
| Field | Type |
|---|---|
Segment ID | text |
Name | text |
Status | text |
Is Starred | boolean |
Condition Groups | array |
Archived At | date |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
NameRequired | text |
ContentRequired | text |
| Field | Type |
|---|---|
ID | text |
Name | text |
Content | text |
Snapshot State | text |
Snapshot URL | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Automation IDRequired | text |
| Field | Type |
|---|---|
Campaign IDRequired | text |
| Field | Type |
|---|---|
Template IDRequired | text |
| Field | Type |
|---|---|
ImageRequired | choice |
| Field | Type |
|---|---|
Product IDRequired | text |
| Field | Type |
|---|---|
Category IDRequired | choice |
| Field | Type |
|---|---|
Segment IDRequired | choice |
| Field | Type |
|---|---|
Layout IDRequired | text |
| Field | Type |
|---|---|
Automation IDRequired | text |
Contacts In WorkflowRequired | choice |
| Field | Type |
|---|---|
Automation ID | text |
Name | text |
Enabled | boolean |
Trigger | object |
Condition | object |
Audience Filter Group | object |
Inactivity Settings | object |
Blocks | text |
Exit Conditions | text |
Settings | text |
Brand ID | text |
Created At | date |
Updated At | date |
Enabled At | date |
Disabled At | date |
| Field | Type |
|---|---|
Automation IDRequired | text |
Enroll Existing Contacts | boolean |
| Field | Type |
|---|---|
Automation ID | text |
Name | text |
Enabled | boolean |
Trigger | object |
Condition | object |
Audience Filter Group | object |
Inactivity Settings | object |
Blocks | text |
Exit Conditions | text |
Settings | text |
Brand ID | text |
Created At | date |
Updated At | date |
Enabled At | date |
Disabled At | date |
| Field | Type |
|---|---|
QueriesRequired | array |
Query | object |
| Field | Type |
|---|---|
Reports | array |
| Field | Type |
|---|---|
QueriesRequired | array |
Query | object |
| Field | Type |
|---|---|
Statistics | array |
| Field | Type |
|---|---|
HTMLRequired | text |
| Field | Type |
|---|---|
ID | text |
Name | text |
Content | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
Headers | array |
Header | object |
Query String | array |
Parameter | object |
Body | text |
| Field | Type |
|---|---|
Body | text |
Headers | object |
Status code | number |
| Field | Type |
|---|---|
CategoryRequired | choice |
Event Names | array |
Event Name | text |
Origins | array |
Origin | text |
Include Properties | boolean |
Exclude Custom Events | boolean |
| Field | Type |
|---|---|
Events | array |
Event | object |
| Field | Type |
|---|---|
TagsRequired | array |
Tag | text |
Contact IDs | choice |
Emails | array |
Email | |
Phones | array |
Phone Number | text |
Segment | choice |
| Field | Type |
|---|---|
Email Content IDRequired | text |
| Field | Type |
|---|---|
Rendered HTML | text |
| Field | Type |
|---|---|
Template IDRequired | text |
| Field | Type |
|---|---|
Rendered HTML | text |
| Field | Type |
|---|---|
Automation IDRequired | text |
BlocksRequired | text |
| Field | Type |
|---|---|
Automation ID | text |
Name | text |
Enabled | boolean |
Trigger | object |
Condition | object |
Audience Filter Group | object |
Inactivity Settings | object |
Blocks | text |
Exit Conditions | text |
Settings | text |
Brand ID | text |
Created At | date |
Updated At | date |
Enabled At | date |
Disabled At | date |
| Field | Type |
|---|---|
Product IDRequired | text |
Product ID (body)Required | text |
TitleRequired | text |
URLRequired | text |
CurrencyRequired | text |
StatusRequired | choice |
Description | text |
Default Image URL | text |
Images | array |
Image URL | text |
Tags | array |
Tag | text |
Type | text |
Vendor | text |
Category IDs | choice |
Variants | array |
Variant | object |
| Field | Type |
|---|---|
Id | text |
Title | text |
Url | text |
Currency | text |
Status | text |
Description | text |
Default Image Url | text |
Images | array |
Image Url | text |
Tags | array |
Tag | text |
Type | text |
Vendor | text |
Category Ids | array |
Category Id | text |
Variants | array |
Variant | object |
Created At | date |
| Field | Type |
|---|---|
Campaign IDRequired | text |
| Field | Type |
|---|---|
Campaign ID | text |
Name | text |
Type | text |
Channel | text |
Status | text |
Language | text |
Brand ID | text |
Content | object |
Email content | object |
SMS content | object |
Audience | object |
Included segment IDs | array |
Excluded segment IDs | array |
Sending settings | object |
Strategy | text |
Scheduled at | date |
Optimize for | text |
Timezone optimization enabled | boolean |
Booster settings | object |
Parent campaign ID | text |
Send to | text |
Delay | object |
A/B test | object |
Settings | object |
Variants | object |
Result | object |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
Campaign IDRequired | text |
Winner VariantRequired | text |
| Field | Type |
|---|---|
Campaign ID | text |
Name | text |
Type | text |
Channel | text |
Status | text |
Language | text |
Brand ID | text |
Content | object |
Email content | object |
SMS content | object |
Audience | object |
Included segment IDs | array |
Excluded segment IDs | array |
Sending settings | object |
Strategy | text |
Scheduled at | date |
Optimize for | text |
Timezone optimization enabled | boolean |
Booster settings | object |
Parent campaign ID | text |
Send to | text |
Delay | object |
A/B test | object |
Settings | object |
Variants | object |
Result | object |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
Automation IDRequired | text |
Block IDRequired | text |
RecipientsRequired | array |
Email Address |
| Field | Type |
|---|---|
Campaign IDRequired | text |
Sending Settings | object |
Strategy | choice |
Scheduled At | date |
| Field | Type |
|---|---|
Campaign ID | text |
Name | text |
Type | text |
Channel | text |
Status | text |
Language | text |
Brand ID | text |
Content | object |
Email content | object |
SMS content | object |
Audience | object |
Included segment IDs | array |
Excluded segment IDs | array |
Sending settings | object |
Strategy | text |
Scheduled at | date |
Optimize for | text |
Timezone optimization enabled | boolean |
Booster settings | object |
Parent campaign ID | text |
Send to | text |
Delay | object |
A/B test | object |
Settings | object |
Variants | object |
Result | object |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
Event NameRequired | choice |
Contact | object |
Email | |
Phone | text |
First Name | text |
Last Name | text |
Contact ID | text |
Address | text |
City | text |
State | text |
Postal Code | text |
Country | text |
Event ID | text |
Event Time | date |
Event Version | text |
Origin | text |
Properties | text |
| Field | Type |
|---|---|
Campaign IDRequired | text |
RecipientsRequired | array |
Email Address |
| Field | Type |
|---|---|
Campaign IDRequired | text |
| Field | Type |
|---|---|
Campaign ID | text |
Name | text |
Type | text |
Channel | text |
Status | text |
Language | text |
Brand ID | text |
Content | object |
Email content | object |
SMS content | object |
Audience | object |
Included segment IDs | array |
Excluded segment IDs | array |
Sending settings | object |
Strategy | text |
Scheduled at | date |
Optimize for | text |
Timezone optimization enabled | boolean |
Booster settings | object |
Parent campaign ID | text |
Send to | text |
Delay | object |
A/B test | object |
Settings | object |
Variants | object |
Result | object |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
Automation IDRequired | text |
Name | text |
Trigger | object |
Condition | object |
Audience Filter Group | object |
Inactivity Settings | object |
Blocks | text |
Exit Conditions | text |
| Field | Type |
|---|---|
Automation ID | text |
Name | text |
Enabled | boolean |
Trigger | object |
Condition | object |
Audience Filter Group | object |
Inactivity Settings | object |
Blocks | text |
Exit Conditions | text |
Settings | text |
Brand ID | text |
Created At | date |
Updated At | date |
Enabled At | date |
Disabled At | date |
| Field | Type |
|---|---|
Automation IDRequired | text |
Block IDRequired | text |
TagsRequired | object |
SourceRequired | text |
MediumRequired | text |
CampaignRequired | text |
| Field | Type |
|---|---|
Tags | object |
Source | text |
Medium | text |
Campaign | text |
| Field | Type |
|---|---|
Campaign IDRequired | text |
Type | choice |
Channel | choice |
Name | text |
Language | text |
Content | object |
Email | object |
SMS | object |
Audience | object |
Included Segment IDs | choice |
Excluded Segment IDs | choice |
Sending Settings | object |
Strategy | choice |
Scheduled At | date |
Optimize For | choice |
Enable Timezone Optimization | boolean |
Booster Settings | object |
Parent Campaign | choice |
Send To | choice |
Delay | object |
A/B Test | object |
Settings | object |
Variants | object |
| Field | Type |
|---|---|
Campaign ID | text |
Name | text |
Type | text |
Channel | text |
Status | text |
Language | text |
Brand ID | text |
Content | object |
Email content | object |
SMS content | object |
Audience | object |
Included segment IDs | array |
Excluded segment IDs | array |
Sending settings | object |
Strategy | text |
Scheduled at | date |
Optimize for | text |
Timezone optimization enabled | boolean |
Booster settings | object |
Parent campaign ID | text |
Send to | text |
Delay | object |
A/B test | object |
Settings | object |
Variants | object |
Result | object |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
Campaign IDRequired | text |
Tags | object |
Source | text |
Medium | text |
Campaign | text |
Variants | object |
Variant A | object |
Variant B | object |
| Field | Type |
|---|---|
Tags | object |
Source | text |
Medium | text |
Campaign | text |
Variants | object |
Variant A | object |
Variant B | object |
| Field | Type |
|---|---|
EmailRequired | |
Identifiers | array |
Identifier | object |
First Name | text |
Last Name | text |
Tags | array |
Tag | text |
Custom Properties | text |
Birthdate | date |
Address | text |
City | text |
Country | text |
Country Code | text |
Gender | choice |
Postal Code | text |
State | text |
| Field | Type |
|---|---|
ID | text |
First Name | text |
Last Name | text |
Email | text |
Phone | array |
Phone Number | text |
Status | text |
Channel Statuses | array |
Channel | text |
Status | text |
Status Changed At | date |
Tags | array |
Tag | text |
Segments | array |
Segment ID | text |
Custom Properties | text |
Address | text |
City | text |
State | text |
Postal Code | text |
| Field | Type |
|---|---|
Contact IDRequired | text |
Identifiers | array |
Identifier | object |
First Name | text |
Last Name | text |
Tags | array |
Tag | text |
Custom Properties | text |
Birthdate | date |
Address | text |
City | text |
Country | text |
Country Code | text |
Gender | choice |
Postal Code | text |
State | text |
| Field | Type |
|---|---|
ID | text |
First Name | text |
Last Name | text |
Email | text |
Phone | array |
Phone Number | text |
Status | text |
Channel Statuses | array |
Channel | text |
Status | text |
Status Changed At | date |
Tags | array |
Tag | text |
Segments | array |
Segment ID | text |
Custom Properties | text |
Address | text |
City | text |
State | text |
Postal Code | text |
| Field | Type |
|---|---|
NameRequired | text |
OriginRequired | text |
Display Name | text |
Properties | text |
| Field | Type |
|---|---|
Event | object |
Name | text |
Display Name | text |
Origins | array |
Explicitly Defined | boolean |
Properties | text |
| Field | Type |
|---|---|
Email Content IDRequired | text |
SectionsRequired | text |
General Settings | text |
| Field | Type |
|---|---|
ID | text |
Sections | text |
General Settings | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Template IDRequired | text |
NameRequired | text |
ContentRequired | text |
| Field | Type |
|---|---|
ID | text |
Name | text |
Content | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Category IDRequired | choice |
TitleRequired | text |
| Field | Type |
|---|---|
Category Id | text |
| Field | Type |
|---|---|
Segment IDRequired | choice |
NameRequired | text |
Condition GroupsRequired | array |
Condition Group | object |
| Field | Type |
|---|---|
Segment ID | text |
Name | text |
Status | text |
Is Starred | boolean |
Condition Groups | array |
Archived At | date |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Layout IDRequired | text |
NameRequired | text |
ContentRequired | text |
| Field | Type |
|---|---|
ID | text |
Name | text |
Content | text |
Snapshot State | text |
Snapshot URL | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Image URLRequired | text |
Name | text |
| Field | Type |
|---|---|
ID | text |
Name | text |
URL | url |
MIME Type | text |
Width | number |
Height | number |
Size (Bytes) | number |
Created At | date |
| Field | Type |
|---|---|
FileRequired | file |
Name | text |
| Field | Type |
|---|---|
ID | text |
Name | text |
URL | url |
MIME Type | text |
Width | number |
Height | number |
Size (Bytes) | number |
Created At | date |