About this integration
Email, SMS, and marketing automation platform (formerly Sendinblue). This integration exposes its full API as workflow modules.
The integration includes 21 triggers, 112 search modules and 174 actions. Connections use basic authentication.
How to connect
The credential form asks for API Key.
Prefer the interactive builder form? Open it on the app page.
Paste your credentials once — WEXTL® stores them encrypted and reuses the connection across every workflow that needs it.
Enter your credentials below. WEXTL stores them encrypted and uses them only to call the API on your behalf.
Connecting Brevo to WEXTL®
| Field | Type | Help |
|---|---|---|
API KeyRequired | password | Your API key. Find it in your account under SMTP & API Keys. |
Use it in workflow automation
Start with Watch Activity Logs, then add Activate Ecommerce.
The canvas below runs Watch Activity Logs into Activate Ecommerce — watch the video, then drop a node onto the canvas.
Select the Watch Email Campaigns trigger and the workflow fires automatically when the event occurs — no polling required.
Then add Create SMS Campaign as the next node. Branch, filter, or hand off to other integrations from there.
The integration includes 195 ready-made modules for communication work — each run logs its inputs and outputs for debugging.
Brevo workflow on the canvas: Watch Email Campaigns then Create SMS Campaign
Triggers, searches and actions
Browse every Brevo module field below: 21 triggers, 112 searchs, and 174 actions you can drop onto the canvas.
Triggers
This integration includes 21 triggers — start a workflow the moment something changes in the app.
- Watch Activity Logs
- Watch Email Campaigns
- Watch Email Events
- Watch Inbound Emails
- Watch New Categories
Searches
Use any of 112 search modules to retrieve records without leaving the workflow canvas.
- Get Account
- Get Attribution Metrics
- Get Attribution Products
- Get Balance Definition
- Get Balance Definition List
Actions
This integration includes 174 action modules — create, update, or delete records as part of any workflow.
- Activate Ecommerce
- Add Subscription to Tier
- Add to List
- Associate IP to Sub-Accounts
- Attribute Reward
Explore the fields available for each Brevo trigger, search, and action.
Triggers
| Field | Type |
|---|---|
Action | text |
Date | date |
User Agent | text |
User Email | |
User IP | text |
| Field | Type |
|---|---|
ID | number |
Name | text |
Subject | text |
Status | text |
Type | text |
| Field | Type |
|---|---|
Date | date |
Email | |
Event | text |
From | |
Message ID | text |
| Field | Type |
|---|---|
UUID | text |
Sender | |
Recipient | |
Date | date |
| Field | Type |
|---|---|
ID | text |
Name | text |
URL | url |
Created At | date |
Modified At | date |
| Field | Type |
|---|---|
ID | number |
Email | |
Email Blacklisted | boolean |
SMS Blacklisted | boolean |
Created At | date |
| Field | Type |
|---|---|
Created At | date |
Default Coupon | text |
Expiration Date | date |
ID | text |
Name | text |
| Field | Type |
|---|---|
ID | text |
Name | text |
Author ID | text |
Contact ID | number |
Deal ID | text |
| Field | Type |
|---|---|
Date | date |
Email | |
From | |
Message ID | text |
Subject | text |
| Field | Type |
|---|---|
ID | text |
Name | text |
URL | url |
Auth Type | text |
Created At | date |
| Field | Type |
|---|---|
ID | number |
Name | text |
Total Blacklisted | number |
Total Subscribers | number |
Unique Subscribers | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
Total Blacklisted | number |
Total Subscribers | number |
Unique Subscribers | number |
| Field | Type |
|---|---|
Contacts | array |
Attributes | object |
Created At | date |
Email | |
Email Blacklisted | boolean |
ID | number |
List Ids | array |
List Unsubscribed | array |
Modified At | date |
SMS Blacklisted | boolean |
Whatsapp Blacklisted | boolean |
Count | number |
| Field | Type |
|---|---|
Count | number |
Lists | array |
ID | number |
Name | text |
Total Blacklisted | number |
Total Subscribers | number |
Unique Subscribers | number |
Folder ID | number |
| Field | Type |
|---|---|
ID | text |
Text | text |
Contact Ids | array |
Contact Ids | number |
Company Ids | array |
Company Ids | text |
Deal Ids | array |
Deal Ids | text |
| Field | Type |
|---|---|
ID | number |
Name | text |
Status | text |
Info | object |
Import | object |
Export URL | url |
| Field | Type |
|---|---|
Brand | text |
Categories | array |
Categories | text |
Created At | date |
Description | text |
ID | text |
| Field | Type |
|---|---|
Category Name | text |
ID | number |
Segment Name | text |
Updated At | date |
| Field | Type |
|---|---|
Active | boolean |
Email | text |
ID | number |
Ips | array |
Name | text |
| Field | Type |
|---|---|
Date | date |
Event | text |
Message ID | text |
Phone Number | text |
Reason | text |
| Field | Type |
|---|---|
ID | text |
Task Type ID | text |
Name | text |
Companies Ids | array |
Companies Ids | text |
Deals Ids | array |
Deals Ids | text |
Searches
| Field | Type |
|---|---|
Organization ID | text |
User ID | number |
Enterprise | boolean |
Company Name | text |
Email |
| Field | Type |
|---|---|
Period From | date |
Period To | date |
Email Campaign IDs | array |
Campaign | choice |
SMS Campaign IDs | array |
Campaign | choice |
| Field | Type |
|---|---|
Results | array |
ID | text |
Conversion Source | text |
Orders Count | number |
Revenue | number |
Average Basket | number |
Totals | object |
Orders Count | number |
Revenue | number |
Average Basket | number |
| Field | Type |
|---|---|
Conversion SourceRequired | choice |
Conversion Source IDRequired | text |
| Field | Type |
|---|---|
Products | array |
ID | text |
Name | text |
Image URL | url |
Price | number |
Orders Count | number |
| Field | Type |
|---|---|
PidRequired | choice |
BdidRequired | choice |
| Field | Type |
|---|---|
ID | text |
Name | text |
Description | text |
Image Ref | url |
Meta | object |
| Field | Type |
|---|---|
PidRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Items | array |
ID | text |
Name | text |
Description | text |
Image Ref | url |
Meta | object |
Unit | text |
Min Amount | number |
Max Amount | number |
Max Credit Amount Limit | number |
Max Debit Amount Limit | number |
| Field | Type |
|---|---|
PidRequired | choice |
BdidRequired | choice |
BlidRequired | choice |
| Field | Type |
|---|---|
ID | text |
Balance Definition ID | text |
Transaction Type | text |
Constraint Type | text |
Duration Value | number |
| Field | Type |
|---|---|
Category IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Name | text |
URL | url |
Created At | date |
Modified At | date |
| Field | Type |
|---|---|
PidRequired | choice |
CpidRequired | choice |
| Field | Type |
|---|---|
Count | number |
| Field | Type |
|---|---|
CompanyRequired | choice |
| Field | Type |
|---|---|
ID | text |
Attributes | object |
Linked Contacts IDs | array |
ID | number |
Linked Deals IDs | array |
ID | text |
| Field | Type |
|---|---|
IdentifierRequired | text |
| Field | Type |
|---|---|
ID | number |
Email | |
Email Blacklisted | boolean |
SMS Blacklisted | boolean |
Created At | date |
| Field | Type |
|---|---|
PidRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Balance Definition ID | text |
Balances | array |
Contact ID | number |
Loyalty Subscription ID | text |
Updated At | date |
Value | number |
Count | number |
Loyalty Program ID | text |
| Field | Type |
|---|---|
IdentifierRequired | text |
Start Date | text |
End Date | text |
| Field | Type |
|---|---|
Messages Sent | array |
Hard Bounces | array |
Soft Bounces | array |
Complaints | array |
Delivered | array |
| Field | Type |
|---|---|
Message IDRequired | text |
| Field | Type |
|---|---|
ID | text |
Text | text |
HTML | text |
Agent ID | text |
Created At | number |
| Field | Type |
|---|---|
User EmailRequired |
| Field | Type |
|---|---|
Email | |
All Features Access | boolean |
Privileges | array |
Feature | text |
Permissions | array |
| Field | Type |
|---|---|
Coupon CollectionRequired | choice |
| Field | Type |
|---|---|
ID | text |
Name | text |
Default Coupon | text |
Remaining Coupons | number |
Total Coupons | number |
| Field | Type |
|---|---|
File IDRequired | text |
| Field | Type |
|---|---|
File URL | url |
| Field | Type |
|---|---|
File IDRequired | text |
| Field | Type |
|---|---|
ID | text |
Name | text |
Size | number |
Type | text |
Created At | date |
| Field | Type |
|---|---|
Pipeline IDRequired | text |
| Field | Type |
|---|---|
Pipeline ID | text |
Pipeline Name | text |
Stages | array |
Stage ID | text |
Stage Name | text |
| Field | Type |
|---|---|
Pipeline ID | text |
Pipeline Name | text |
Stages | array |
Stage ID | text |
Stage Name | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
Title | text |
| Field | Type |
|---|---|
DealRequired | choice |
| Field | Type |
|---|---|
ID | text |
Attributes | object |
Linked Contacts IDs | array |
Contact ID | number |
Linked Companies IDs | array |
Company ID | text |
| Field | Type |
|---|---|
Currency | text |
| Field | Type |
|---|---|
Domain NameRequired | text |
| Field | Type |
|---|---|
Domain | text |
Verified | boolean |
Authenticated | boolean |
DNS Records | object |
Brevo Code | object |
DKIM Record | object |
DMARC Record | object |
| Field | Type |
|---|---|
Email CampaignRequired | choice |
Statistics | choice |
| Field | Type |
|---|---|
ID | number |
Name | text |
Subject | text |
Type | text |
Status | text |
| Field | Type |
|---|---|
Email CampaignRequired | choice |
| Field | Type |
|---|---|
Winning Version | text |
Winning Criteria | text |
Winning Subject Line | text |
Open Rate | object |
Click Rate | object |
| Field | Type |
|---|---|
Email CampaignRequired | choice |
| Field | Type |
|---|---|
Shared URL | url |
| Field | Type |
|---|---|
UUIDRequired | choice |
| Field | Type |
|---|---|
Date | text |
Email | text |
Events | array |
Subject | text |
Body | text |
| Field | Type |
|---|---|
Start Date | date |
End Date | date |
Days | number |
Tag | text |
| Field | Type |
|---|---|
Blocked | number |
Clicks | number |
Delivered | number |
Hard bounces | number |
Invalid | number |
| Field | Type |
|---|---|
Start Date | text |
End Date | text |
Days | number |
Tag | text |
Sort | choice |
| Field | Type |
|---|---|
Date | date |
Requests | number |
Delivered | number |
Hard Bounces | number |
Soft Bounces | number |
| Field | Type |
|---|---|
External FeedRequired | choice |
| Field | Type |
|---|---|
ID | text |
Name | text |
URL | url |
Auth Type | text |
Max Retries | number |
| Field | Type |
|---|---|
FolderRequired | choice |
| Field | Type |
|---|---|
ID | number |
Name | text |
Total Blacklisted | number |
Total Subscribers | number |
| Field | Type |
|---|---|
GroupRequired | choice |
| Field | Type |
|---|---|
Group | object |
ID | text |
Group Name | text |
Created At | text |
Sub-Accounts | array |
ID | number |
Company Name | text |
Created At | text |
Users | array |
Email | |
First Name | text |
Last Name | text |
| Field | Type |
|---|---|
UUIDRequired | text |
| Field | Type |
|---|---|
Received At | date |
Delivered At | date |
Sender | |
Recipient | |
Subject | text |
| Field | Type |
|---|---|
ListRequired | choice |
| Field | Type |
|---|---|
ID | number |
Name | text |
Folder ID | number |
Total Blacklisted | number |
Total Subscribers | number |
| Field | Type |
|---|---|
Loyalty ProgramRequired | choice |
Contact ID | text |
Loyalty Subscription ID | text |
Include Internal | boolean |
Params | text |
| Field | Type |
|---|---|
Balance | object |
Tiers | array |
Rewards | array |
| Field | Type |
|---|---|
Loyalty ProgramRequired | choice |
Contact ID | number |
Loyalty Subscription ID | text |
Balance Definition ID | text |
Sort Field | text |
| Field | Type |
|---|---|
ID | text |
Amount | number |
Contact ID | number |
Loyalty Program ID | text |
Balance Definition ID | text |
| Field | Type |
|---|---|
PidRequired | choice |
RidRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Attribution Per Consumer | number |
Balance Definition ID | text |
Code | text |
Code Count | number |
Code Generator ID | text |
| Field | Type |
|---|---|
PidRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Contact ID | number |
Contact Rewards | array |
Code | text |
Consumed At | date |
Created At | date |
Expiration Date | text |
ID | text |
Meta | object |
Reward ID | text |
Unit | text |
Updated At | date |
Value | number |
Count | number |
Loyalty Program ID | text |
Loyalty Subscription ID | text |
| Field | Type |
|---|---|
Loyalty ProgramRequired | choice |
| Field | Type |
|---|---|
ID | text |
Name | text |
Description | text |
Document ID | text |
Meta | object |
| Field | Type |
|---|---|
ID | number |
Company Name | text |
Email | |
Currency Code | text |
Timezone | text |
| Field | Type |
|---|---|
User EmailRequired |
| Field | Type |
|---|---|
Token | text |
| Field | Type |
|---|---|
Note IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Text | text |
Contact IDs | array |
Contact ID | number |
Company IDs | array |
Company ID | text |
Deal IDs | array |
Deal ID | text |
| Field | Type |
|---|---|
User EmailRequired |
| Field | Type |
|---|---|
Email | |
Status | text |
Privileges | array |
Feature | text |
Permissions | array |
| Field | Type |
|---|---|
Payment Request IDRequired | text |
| Field | Type |
|---|---|
ID | text |
Reference | text |
Status | text |
Payment URL | url |
Amount | number |
| Field | Type |
|---|---|
ProcessRequired | choice |
| Field | Type |
|---|---|
ID | number |
Name | text |
Status | text |
Export URL | url |
Info | object |
| Field | Type |
|---|---|
Product IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Name | text |
Price | number |
SKU | text |
URL | url |
| Field | Type |
|---|---|
Message IDRequired | text |
| Field | Type |
|---|---|
ID | text |
Text | text |
Created At | number |
| Field | Type |
|---|---|
Start Date | text |
End Date | text |
Days | number |
Tag | text |
| Field | Type |
|---|---|
Range | text |
Requests | number |
Delivered | number |
Hard Bounces | number |
Soft Bounces | number |
| Field | Type |
|---|---|
SMS CampaignRequired | choice |
| Field | Type |
|---|---|
ID | number |
Name | text |
Status | text |
Content | text |
Sender | text |
| Field | Type |
|---|---|
Start Date | text |
End Date | text |
Days | number |
Tag | text |
Sort | choice |
| Field | Type |
|---|---|
Date | date |
Requests | number |
Delivered | number |
Hard Bounces | number |
Soft Bounces | number |
| Field | Type |
|---|---|
Conversion SourceRequired | choice |
Conversion Source IDRequired | text |
| Field | Type |
|---|---|
ID | text |
Conversion Source | text |
Orders Count | number |
Revenue | number |
Average Basket | number |
| Field | Type |
|---|---|
Sub-AccountRequired | choice |
| Field | Type |
|---|---|
Company Name | text |
Email | |
Name | text |
Groups | array |
ID | text |
Name | text |
Plan Info | object |
Plan Type | text |
| Field | Type |
|---|---|
PidRequired | choice |
CidRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Loyalty Program ID | text |
Contact ID | number |
Balance | array |
Balance Definition ID | text |
Value | number |
| Field | Type |
|---|---|
Task IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Name | text |
Task Type ID | text |
Due Date | date |
Done | boolean |
| Field | Type |
|---|---|
TemplateRequired | choice |
| Field | Type |
|---|---|
ID | number |
Name | text |
Subject | text |
Is Active | boolean |
DOI Template | boolean |
| Field | Type |
|---|---|
Loyalty ProgramRequired | choice |
Tier GroupRequired | choice |
Version | choice |
| Field | Type |
|---|---|
ID | text |
Name | text |
Upgrade Strategy | text |
Downgrade Strategy | text |
Tier Order | array |
Tier ID | text |
| Field | Type |
|---|---|
WhatsApp CampaignRequired | choice |
| Field | Type |
|---|---|
ID | number |
Campaign Name | text |
Campaign Status | text |
Scheduled At | date |
Created At | date |
| Field | Type |
|---|---|
WebhookRequired | choice |
| Field | Type |
|---|---|
ID | number |
URL | url |
Description | text |
Events | array |
Event | text |
Type | text |
| Field | Type |
|---|---|
Phone Number | text |
WhatsApp Account ID | text |
Created At | date |
| Field | Type |
|---|---|
Start Date | text |
End Date | text |
User Email | |
Limit | number |
| Field | Type |
|---|---|
Action | text |
Date | date |
User Agent | text |
User Email | |
User IP | text |
| Field | Type |
|---|---|
User Type | choice |
Limit | number |
| Field | Type |
|---|---|
Email | |
Is Owner | boolean |
Status | text |
Feature Access | object |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Category | text |
Name | text |
Type | text |
Enumeration | array |
Value | number |
Label | text |
Multi Category Options | array |
Option | text |
| Field | Type |
|---|---|
Start Date | date |
End Date | date |
Senders | array |
Sender Email | |
Sort | choice |
Limit | number |
| Field | Type |
|---|---|
Blocked at | date |
Email | |
Reason | object |
Code | text |
Message | text |
Sender email |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Domain | text |
Created At | date |
| Field | Type |
|---|---|
Category IDs | array |
ID | text |
Name | text |
Sort | choice |
Created Since | date |
Modified Since | date |
| Field | Type |
|---|---|
ID | text |
Name | text |
URL | url |
Created At | date |
Modified At | date |
| Field | Type |
|---|---|
Name Filter | text |
Linked Contact IDs | text |
Linked Deal IDs | text |
Sort | choice |
Sort By | text |
| Field | Type |
|---|---|
ID | text |
Attributes | object |
Linked Contacts IDs | array |
ID | number |
Linked Deals IDs | array |
ID | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
Name | text |
Label | text |
Type | text |
| Field | Type |
|---|---|
Modified Since | date |
Created Since | date |
Sort | choice |
Segment ID | choice |
List IDs | array |
List | choice |
| Field | Type |
|---|---|
ID | number |
Email | |
Email Blacklisted | boolean |
SMS Blacklisted | boolean |
Created At | date |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
IP | text |
Domain | text |
Transactional | boolean |
| Field | Type |
|---|---|
Sort | choice |
Sort By | text |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Name | text |
Default Coupon | text |
Remaining Coupons | number |
Total Coupons | number |
| Field | Type |
|---|---|
Entity Type | choice |
Entity IDs | text |
Date From (Unix ms) | number |
Date To (Unix ms) | number |
Sort | choice |
| Field | Type |
|---|---|
ID | text |
Name | text |
Size | number |
Type | text |
Created At | date |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
Name | text |
Label | text |
Type | text |
| Field | Type |
|---|---|
Deal Name Filter | text |
Linked Companies IDs | text |
Linked Contacts IDs | text |
Sort | choice |
Sort By | text |
| Field | Type |
|---|---|
ID | text |
Attributes | object |
Deal Name | text |
Amount | number |
Deal Stage | text |
Close Date | text |
Linked Contacts IDs | array |
Contact ID | number |
Linked Companies IDs | array |
Company ID | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | number |
IP | text |
Domain | text |
Active | boolean |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
Domain Name | text |
Authenticated | boolean |
Verified | boolean |
IP | text |
| Field | Type |
|---|---|
Type | choice |
Status | choice |
Statistics | choice |
Start Date | text |
End Date | text |
| Field | Type |
|---|---|
ID | number |
Name | text |
Subject | text |
Type | text |
Status | text |
| Field | Type |
|---|---|
Start Date | text |
End Date | text |
Days | number |
Email | |
Event Type | choice |
| Field | Type |
|---|---|
Date | date |
Email | |
Event | text |
Message ID | text |
From | text |
| Field | Type |
|---|---|
Email | |
Template | choice |
Message ID | text |
Start Date | text |
End Date | text |
| Field | Type |
|---|---|
Date | date |
Email | |
Message ID | text |
Subject | text |
UUID | text |
| Field | Type |
|---|---|
Contact ID | number |
Event Name | text |
Event Filter ID | text |
Object Type | text |
Start Date | text |
| Field | Type |
|---|---|
Contact ID | number |
Event Date | date |
Event Name | text |
Event Filter ID | text |
Object Type | text |
| Field | Type |
|---|---|
Search | text |
Start Date | text |
End Date | text |
Sort | choice |
Auth Type | choice |
| Field | Type |
|---|---|
ID | text |
Name | text |
URL | url |
Auth Type | text |
Username | text |
| Field | Type |
|---|---|
FolderRequired | choice |
Sort | choice |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
Folder ID | number |
Total Blacklisted | number |
Total Subscribers | number |
| Field | Type |
|---|---|
Sort | choice |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
Total Blacklisted | number |
Total Subscribers | number |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
Group Name | text |
| Field | Type |
|---|---|
Sender | |
Start Date | text |
End Date | text |
Sort | choice |
Limit | number |
| Field | Type |
|---|---|
UUID | text |
Sender | |
Recipient | |
Date | date |
| Field | Type |
|---|---|
ListRequired | choice |
Modified Since | date |
Created Since | date |
Sort | choice |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Email | |
Email Blacklisted | boolean |
SMS Blacklisted | boolean |
Created At | date |
| Field | Type |
|---|---|
Sort | choice |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
Folder ID | number |
Total Blacklisted | number |
Total Subscribers | number |
| Field | Type |
|---|---|
Sort Field | text |
Sort Order | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Name | text |
Description | text |
Document ID | text |
Meta | object |
| Field | Type |
|---|---|
Loyalty ProgramRequired | choice |
State | text |
Version | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Name | text |
Loyalty Program ID | text |
State | text |
Start Date | date |
| Field | Type |
|---|---|
Loyalty ProgramRequired | choice |
Contact IDRequired | number |
Balance Definition IDRequired | text |
Status | choice |
Transaction Type | choice |
| Field | Type |
|---|---|
ID | text |
Amount | number |
Transaction Type | text |
Status | text |
Created At | date |
| Field | Type |
|---|---|
Entity Type | choice |
Entity IDs | text |
Date From (Unix ms) | number |
Date To (Unix ms) | number |
Sort | choice |
| Field | Type |
|---|---|
ID | text |
Text | text |
Contact IDs | array |
Contact ID | number |
Company IDs | array |
Company ID | text |
Deal IDs | array |
Deal ID | text |
| Field | Type |
|---|---|
Object TypeRequired | text |
Sort | choice |
Include Associations | choice |
Limit | number |
| Field | Type |
|---|---|
Identifiers | object |
ID | number |
External ID | text |
Attributes | object |
Associations | array |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Modified Since | date |
Created Since | date |
Sort | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Status | text |
Amount | number |
Contact Email | |
Created At | date |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Email | |
Is Owner | boolean |
Status | text |
Feature Access | object |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Pipeline ID | text |
Pipeline Name | text |
Stages | array |
Stage ID | text |
Stage Name | text |
| Field | Type |
|---|---|
Sort | choice |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
Status | text |
Export URL | url |
Info | object |
Import | object |
| Field | Type |
|---|---|
Product IDs | array |
ID | text |
Name | text |
Max Price | number |
Min Price | number |
Sort | choice |
| Field | Type |
|---|---|
ID | text |
Name | text |
Price | number |
SKU | text |
Image URL | url |
| Field | Type |
|---|---|
Batch ID or Message IDRequired | choice |
Start Date | date |
End Date | date |
Sort | choice |
Status | choice |
| Field | Type |
|---|---|
Scheduled At | date |
Created At | date |
Status | text |
| Field | Type |
|---|---|
Sort | choice |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Segment Name | text |
Created At | date |
Recipients Count | number |
| Field | Type |
|---|---|
SenderRequired | choice |
Limit | number |
| Field | Type |
|---|---|
ID | number |
IP | text |
Domain | text |
Weight | number |
| Field | Type |
|---|---|
IP | text |
Domain | text |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
Email | |
Active | boolean |
IPs | array |
IP | text |
Domain | text |
Weight | number |
| Field | Type |
|---|---|
Status | choice |
Start Date | text |
End Date | text |
Sort | choice |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
Status | text |
Content | text |
Sender | text |
| Field | Type |
|---|---|
Start Date | text |
End Date | text |
Days | number |
Phone Number | text |
Event Type | choice |
| Field | Type |
|---|---|
Phone Number | text |
Date | date |
Message ID | text |
Event | text |
Reason | text |
| Field | Type |
|---|---|
Search | text |
Sort | choice |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
Content | text |
Sender | text |
Tag | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | number |
Company Name | text |
Email |
| Field | Type |
|---|---|
Task Type | choice |
Status Filter | choice |
Date Filter | choice |
Assign To Filter | text |
Contacts Filter | text |
| Field | Type |
|---|---|
ID | text |
Name | text |
Task Type ID | text |
Due Date | date |
Done | boolean |
| Field | Type |
|---|---|
Active Templates Only | boolean |
Editor Type | choice |
Sort | choice |
Limit | number |
| Field | Type |
|---|---|
Created at | date |
HTML content | text |
ID | number |
Is active | boolean |
Modified at | date |
| Field | Type |
|---|---|
Loyalty ProgramRequired | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Name | text |
Upgrade Strategy | text |
Downgrade Strategy | text |
Tier Order | array |
Tier ID | text |
| Field | Type |
|---|---|
Loyalty ProgramRequired | choice |
Version | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Name | text |
Access Conditions | array |
Balance Definition ID | text |
Minimum Value | number |
| Field | Type |
|---|---|
Start Date | text |
End Date | text |
Sort | choice |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Campaign Name | text |
Campaign Status | text |
Scheduled At | date |
Template ID | number |
| Field | Type |
|---|---|
Type | choice |
Sort | choice |
Limit | number |
| Field | Type |
|---|---|
ID | number |
URL | url |
Description | text |
Events | array |
Event | text |
Type | text |
| Field | Type |
|---|---|
Start Date | text |
End Date | text |
Sort | choice |
Event Type | choice |
Contact Number | text |
| Field | Type |
|---|---|
Date | date |
Contact Number | text |
Event | text |
Message ID | text |
Template ID | number |
| Field | Type |
|---|---|
Start Date | text |
End Date | text |
Sort | choice |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
Status | text |
Language | text |
Category | text |
Actions
No fields documented.
| Field | Type |
|---|---|
PidRequired | choice |
CidRequired | choice |
TidRequired | choice |
| Field | Type |
|---|---|
Contact ID | number |
Created At | date |
Group ID | text |
ID | text |
Loyalty Program ID | text |
| Field | Type |
|---|---|
ListRequired | choice |
Emails | array |
Email | |
Contact IDs | array |
Contact ID | number |
| Field | Type |
|---|---|
Contacts | object |
Failure | text |
Process ID | number |
Success | text |
Total | number |
| Field | Type |
|---|---|
IP AddressRequired | text |
Sub-Account IDsRequired | array |
Sub-Account | choice |
| Field | Type |
|---|---|
Loyalty ProgramRequired | choice |
Reward IDRequired | text |
Contact ID | number |
Loyalty Subscription ID | text |
Code | text |
| Field | Type |
|---|---|
ID | text |
Code | text |
Contact ID | number |
Reward ID | text |
Value | number |
| Field | Type |
|---|---|
Domain NameRequired | text |
| Field | Type |
|---|---|
Domain Name | text |
Message | text |
| Field | Type |
|---|---|
CategoriesRequired | array |
Category ID | text |
Name | text |
URL | url |
Deleted At | text |
Update Enabled | boolean |
| Field | Type |
|---|---|
Created Count | number |
Updated Count | number |
| Field | Type |
|---|---|
EventsRequired | array |
Event Name | text |
Identifiers | object |
Event Date | text |
Event Properties | object |
Contact Properties | object |
Object | object |
| Field | Type |
|---|---|
Message | text |
Count | number |
| Field | Type |
|---|---|
OrdersRequired | array |
Order ID | text |
Status | choice |
Amount | number |
Email | |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Batch ID | number |
Count | number |
| Field | Type |
|---|---|
ProductsRequired | array |
Product ID | text |
Name | text |
URL | url |
Image URL | url |
SKU | text |
Price | number |
Categories | array |
Deleted At | text |
Update Enabled | boolean |
| Field | Type |
|---|---|
Created Count | number |
Updated Count | number |
| Field | Type |
|---|---|
ContactsRequired | array |
Email | |
ID | number |
SMS | text |
External ID | text |
Attributes | object |
Email Blacklisted | boolean |
SMS Blacklisted | boolean |
Add to List IDs | array |
Remove from List IDs | array |
SMTP Blacklist Senders | array |
| Field | Type |
|---|---|
DomainRequired | text |
| Field | Type |
|---|---|
Sub-Account IDsRequired | array |
Sub-Account | choice |
Credits | object |
Email Credits | number |
SMS Credits | number |
WhatsApp Credits | number |
Push Credits | number |
External Feeds | number |
Features | object |
Landing Pages | number |
Sales Users | number |
Users | number |
| Field | Type |
|---|---|
Loyalty ProgramRequired | choice |
Transaction IDRequired | text |
| Field | Type |
|---|---|
ID | text |
Status | text |
Amount | number |
| Field | Type |
|---|---|
Loyalty ProgramRequired | choice |
Transaction IDRequired | text |
| Field | Type |
|---|---|
ID | text |
Status | text |
Amount | number |
| Field | Type |
|---|---|
PidRequired | choice |
TidRequired | choice |
| Field | Type |
|---|---|
Cancelled At | date |
Completed At | date |
Contact ID | number |
Created At | date |
Debit Transaction ID | text |
| Field | Type |
|---|---|
Attribute CategoryRequired | choice |
Attribute NameRequired | text |
Type | choice |
Value | text |
Enumeration | array |
Value | number |
Label | text |
| Field | Type |
|---|---|
PidRequired | choice |
BdidRequired | choice |
Constraint TypeRequired | text |
Duration UnitRequired | text |
Duration ValueRequired | number |
| Field | Type |
|---|---|
ID | text |
Balance Definition ID | text |
Transaction Type | text |
Constraint Type | text |
Duration Value | number |
| Field | Type |
|---|---|
PidRequired | choice |
AmountRequired | number |
Balance Definition IDRequired | choice |
Contact IDRequired | choice |
Due AtRequired | text |
| Field | Type |
|---|---|
Amount | number |
Balance Definition ID | text |
Contact ID | number |
Created At | date |
Due At | date |
| Field | Type |
|---|---|
Email | |
External ID | text |
Attributes | object |
Email Blacklisted | boolean |
SMS Blacklisted | boolean |
| Field | Type |
|---|---|
ID | number |
| Field | Type |
|---|---|
NameRequired | text |
Default CouponRequired | text |
Expiration Date | date |
Remaining Coupons Alert | number |
Remaining Days Alert | number |
| Field | Type |
|---|---|
ID | text |
| Field | Type |
|---|---|
Coupon CollectionRequired | choice |
CouponsRequired | array |
Coupon Code | text |
| Field | Type |
|---|---|
Attribute TypeRequired | text |
Description | text |
LabelRequired | text |
Object TypeRequired | text |
Options Labels | array |
Options Labels | text |
| Field | Type |
|---|---|
ID | text |
| Field | Type |
|---|---|
Company NameRequired | text |
Attributes | object |
Linked Contact IDs | array |
Contact | choice |
Linked Deal IDs | array |
Deal | choice |
| Field | Type |
|---|---|
ID | text |
| Field | Type |
|---|---|
Deal NameRequired | text |
Attributes | object |
Linked Contact IDs | array |
Contact | choice |
Linked Company IDs | array |
Company | choice |
| Field | Type |
|---|---|
ID | text |
| Field | Type |
|---|---|
EmailRequired | |
DOI TemplateRequired | choice |
Redirection URLRequired | url |
Include List IDsRequired | array |
List | choice |
Exclude List IDs | array |
List | choice |
| Field | Type |
|---|---|
Domain NameRequired | text |
| Field | Type |
|---|---|
ID | text |
Domain Name | text |
Domain Provider | text |
Message | text |
DNS Records | object |
Brevo Code | object |
DKIM Record | object |
DMARC Record | object |
| Field | Type |
|---|---|
NameRequired | text |
Subject | text |
SenderRequired | object |
Name | text |
Email | |
ID | number |
TypeRequired | choice |
HTML Content | text |
| Field | Type |
|---|---|
ID | number |
| Field | Type |
|---|---|
Event NameRequired | text |
IdentifiersRequired | object |
Contact ID | number |
Email ID | |
External ID | text |
Phone ID | text |
WhatsApp ID | text |
Landline Number ID | text |
Event Date | date |
Event Properties | object |
Contact Properties | object |
| Field | Type |
|---|---|
NameRequired | text |
URLRequired | url |
Auth Type | choice |
Username | text |
Password | secret |
| Field | Type |
|---|---|
ID | text |
| Field | Type |
|---|---|
NameRequired | text |
| Field | Type |
|---|---|
ID | number |
| Field | Type |
|---|---|
Group NameRequired | text |
Sub-Account IDs | array |
Sub-Account | choice |
| Field | Type |
|---|---|
ID | text |
| Field | Type |
|---|---|
NameRequired | text |
FolderRequired | choice |
| Field | Type |
|---|---|
ID | number |
| Field | Type |
|---|---|
PidRequired | choice |
Balance Availability Duration Modifier | text |
Balance Availability Duration Unit | text |
Balance Availability Duration Value | number |
Balance Expiration Date | text |
| Field | Type |
|---|---|
ID | text |
Name | text |
Description | text |
Image Ref | url |
Meta | object |
| Field | Type |
|---|---|
PidRequired | choice |
CidRequired | choice |
Balance Definition IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Amount | number |
Loyalty Program ID | text |
Organization ID | number |
Contact ID | number |
| Field | Type |
|---|---|
NameRequired | text |
Description | text |
Document ID | text |
Meta | object |
| Field | Type |
|---|---|
ID | text |
Name | text |
| Field | Type |
|---|---|
Loyalty ProgramRequired | choice |
NameRequired | text |
Public Name | text |
Public Description | text |
Public Image URL | url |
| Field | Type |
|---|---|
ID | text |
Name | text |
Loyalty Program ID | text |
Created At | date |
| Field | Type |
|---|---|
Loyalty ProgramRequired | choice |
AmountRequired | number |
Balance Definition IDRequired | text |
Transaction Type | choice |
Contact ID | number |
| Field | Type |
|---|---|
ID | text |
Amount | number |
Transaction Type | text |
Status | text |
Contact ID | number |
| Field | Type |
|---|---|
TextRequired | text |
Contact IDs | array |
Contact | choice |
Company IDs | array |
Company | choice |
Deal IDs | array |
Deal | choice |
| Field | Type |
|---|---|
ID | text |
| Field | Type |
|---|---|
Category IDRequired | choice |
Name | text |
URL | url |
Update Enabled | boolean |
Deleted At | text |
| Field | Type |
|---|---|
ID | text |
| Field | Type |
|---|---|
Order IDRequired | text |
StatusRequired | choice |
AmountRequired | number |
Customer Email | |
Billing | object |
Address | text |
City | text |
Country Code | text |
Zip Code | text |
| Field | Type |
|---|---|
Product IDRequired | choice |
NameRequired | text |
URL | url |
Image URL | url |
SKU | text |
| Field | Type |
|---|---|
ID | text |
| Field | Type |
|---|---|
ReferenceRequired | text |
CartRequired | object |
Items | array |
Contact ID | number |
Contact Email | |
Description | text |
| Field | Type |
|---|---|
ID | text |
Status | text |
Payment URL | url |
| Field | Type |
|---|---|
NameRequired | text |
EmailRequired | |
IPs | array |
IP | text |
Domain | text |
Weight | number |
| Field | Type |
|---|---|
ID | number |
DKIM Error | boolean |
SPF Error | boolean |
| Field | Type |
|---|---|
NameRequired | text |
SenderRequired | text |
ContentRequired | text |
Recipients | object |
List IDs | array |
Exclusion List IDs | array |
Scheduled At | date |
| Field | Type |
|---|---|
ID | number |
| Field | Type |
|---|---|
Company NameRequired | text |
EmailRequired | |
Language | choice |
Timezone | text |
Group IDs | array |
Group | choice |
| Field | Type |
|---|---|
ID | number |
| Field | Type |
|---|---|
Sub-AccountRequired | choice |
Key NameRequired | text |
| Field | Type |
|---|---|
API Key | text |
Status | text |
| Field | Type |
|---|---|
NameRequired | text |
Task TypeRequired | choice |
Due DateRequired | date |
Duration (ms) | number |
Assign To | text |
| Field | Type |
|---|---|
ID | text |
| Field | Type |
|---|---|
Template NameRequired | text |
SubjectRequired | text |
SenderRequired | object |
Name | text |
Email | |
ID | number |
HTML Content | text |
HTML URL | url |
| Field | Type |
|---|---|
ID | number |
| Field | Type |
|---|---|
Loyalty ProgramRequired | choice |
Tier Group IDRequired | text |
Name | text |
Access Conditions | array |
Balance Definition ID | text |
Minimum Value | number |
Meta | object |
| Field | Type |
|---|---|
ID | text |
Name | text |
| Field | Type |
|---|---|
Loyalty ProgramRequired | choice |
NameRequired | text |
Upgrade Strategy | choice |
Downgrade Strategy | choice |
Tier Order | array |
Tier ID | text |
| Field | Type |
|---|---|
ID | text |
Name | text |
| Field | Type |
|---|---|
URLRequired | url |
Description | text |
EventsRequired | array |
Event | choice |
TypeRequired | choice |
Domain | text |
| Field | Type |
|---|---|
ID | number |
| Field | Type |
|---|---|
NameRequired | text |
RecipientsRequired | object |
Scheduled AtRequired | text |
Template IDRequired | choice |
| Field | Type |
|---|---|
Template NameRequired | text |
LanguageRequired | text |
CategoryRequired | choice |
Body TextRequired | text |
Header Text | text |
| Field | Type |
|---|---|
ID | number |
Name | text |
| Field | Type |
|---|---|
Attribute CategoryRequired | choice |
Attribute NameRequired | text |
| Field | Type |
|---|---|
Attribute TypeRequired | choice |
Multiple Choice AttributeRequired | text |
Option to DeleteRequired | text |
| Field | Type |
|---|---|
PidRequired | choice |
BdidRequired | choice |
| Field | Type |
|---|---|
PidRequired | choice |
BdidRequired | choice |
BlidRequired | choice |
| Field | Type |
|---|---|
EmailRequired |
| Field | Type |
|---|---|
CompanyRequired | choice |
| Field | Type |
|---|---|
IdentifierRequired | text |
| Field | Type |
|---|---|
PidRequired | choice |
| Field | Type |
|---|---|
PidRequired | choice |
CidRequired | choice |
| Field | Type |
|---|---|
Message IDRequired | text |
| Field | Type |
|---|---|
IDRequired | choice |
| Field | Type |
|---|---|
File IDRequired | text |
| Field | Type |
|---|---|
DealRequired | choice |
| Field | Type |
|---|---|
Domain NameRequired | text |
| Field | Type |
|---|---|
Email CampaignRequired | choice |
| Field | Type |
|---|---|
IdentifierRequired | choice |
From Date | date |
To Date | date |
| Field | Type |
|---|---|
External FeedRequired | choice |
| Field | Type |
|---|---|
FolderRequired | choice |
| Field | Type |
|---|---|
GroupRequired | choice |
| Field | Type |
|---|---|
Start Date | text |
End Date | text |
Contact Email |
| Field | Type |
|---|---|
ListRequired | choice |
| Field | Type |
|---|---|
Loyalty ProgramRequired | choice |
| Field | Type |
|---|---|
Note IDRequired | choice |
| Field | Type |
|---|---|
Object TypeRequired | text |
IdentifiersRequired | object |
IDs | array |
External IDs | array |
| Field | Type |
|---|---|
Process ID | number |
| Field | Type |
|---|---|
Payment Request IDRequired | text |
| Field | Type |
|---|---|
Message IDRequired | text |
| Field | Type |
|---|---|
Batch ID or Message IDRequired | choice |
| Field | Type |
|---|---|
SenderRequired | choice |
| Field | Type |
|---|---|
Campaign IDRequired | choice |
| Field | Type |
|---|---|
Sub-AccountRequired | choice |
| Field | Type |
|---|---|
Task IDRequired | choice |
| Field | Type |
|---|---|
TemplateRequired | choice |
| Field | Type |
|---|---|
Loyalty ProgramRequired | choice |
Tier IDRequired | text |
| Field | Type |
|---|---|
Loyalty ProgramRequired | choice |
Tier Group IDRequired | text |
| Field | Type |
|---|---|
WebhookRequired | choice |
| Field | Type |
|---|---|
Campaign IDRequired | choice |
| Field | Type |
|---|---|
IP AddressRequired | text |
Sub-Account IDsRequired | array |
Sub-Account | choice |
| Field | Type |
|---|---|
Download TokenRequired | text |
| Field | Type |
|---|---|
File Data | text |
| Field | Type |
|---|---|
Custom Contact FilterRequired | object |
Action For Contacts | choice |
Action For Email Campaigns | choice |
Action For SMS Campaigns | choice |
List | choice |
Segment ID | number |
Email Campaign | choice |
SMS Campaign | choice |
Export Attributes | array |
Attribute | text |
Export Mandatory Attributes | boolean |
Export Metadata | array |
Metadata Field | text |
Export Date in UTC | boolean |
| Field | Type |
|---|---|
Process ID | number |
| Field | Type |
|---|---|
Email CampaignRequired | choice |
Recipients TypeRequired | choice |
Notify URL | url |
| Field | Type |
|---|---|
Process ID | number |
| Field | Type |
|---|---|
SMS CampaignRequired | choice |
Recipients TypeRequired | choice |
Notify URL | url |
| Field | Type |
|---|---|
Process ID | number |
| Field | Type |
|---|---|
Event TypeRequired | choice |
Notify URLRequired | url |
Webhook TypeRequired | choice |
Days | number |
Start Date | text |
| Field | Type |
|---|---|
Process ID | number |
| Field | Type |
|---|---|
Sub-AccountRequired | choice |
User Email | |
Target Page | choice |
Target URL | url |
| Field | Type |
|---|---|
Token | text |
| Field | Type |
|---|---|
File URLRequired | url |
Column Mapping | object |
| Field | Type |
|---|---|
Process ID | number |
| Field | Type |
|---|---|
File URL | url |
File Body | text |
JSON Body | array |
Email | |
Attributes | object |
List IDs | array |
List | choice |
New List | object |
List Name | text |
Folder | choice |
| Field | Type |
|---|---|
Process ID | number |
| Field | Type |
|---|---|
File URLRequired | url |
Column Mapping | object |
| Field | Type |
|---|---|
Process ID | number |
| Field | Type |
|---|---|
EmailRequired | |
All Features AccessRequired | boolean |
Group IDs | array |
Group | choice |
Privileges | array |
Feature | text |
Permissions | array |
| Field | Type |
|---|---|
ID | text |
| Field | Type |
|---|---|
EmailRequired | |
All Features AccessRequired | boolean |
Privileges | array |
Feature | choice |
Permissions | array |
| Field | Type |
|---|---|
Status | text |
Invoice ID | text |
| Field | Type |
|---|---|
DealRequired | choice |
Link Contact IDs | array |
Contact | choice |
Unlink Contact IDs | array |
Contact | choice |
Link Company IDs | array |
Company | choice |
Unlink Company IDs | array |
Company | choice |
| Field | Type |
|---|---|
CompanyRequired | choice |
Link Contact IDs | array |
Contact ID | number |
Unlink Contact IDs | array |
Contact ID | number |
Link Deal IDs | array |
Deal ID | text |
Unlink Deal IDs | array |
Deal ID | text |
| 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 |
|---|---|
ActionRequired | choice |
User EmailRequired |
| Field | Type |
|---|---|
Status | text |
Credit Notes | array |
Credit Note | text |
| Field | Type |
|---|---|
Loyalty ProgramRequired | choice |
Name | text |
Description | text |
Meta | object |
| Field | Type |
|---|---|
ID | text |
Name | text |
| Field | Type |
|---|---|
Agent ID | text |
Agent Email | |
Agent Name | text |
Received From | text |
| Field | Type |
|---|---|
TemplateRequired | choice |
Contact Email | |
Params | object |
| Field | Type |
|---|---|
From Email | |
From Name | text |
HTML | text |
Preview Text | text |
Subject | text |
| Field | Type |
|---|---|
PidRequired | choice |
| Field | Type |
|---|---|
Loyalty ProgramRequired | choice |
Attributed Reward ID | text |
Redemption Code | text |
Contact ID | number |
Loyalty Subscription ID | text |
| Field | Type |
|---|---|
ID | text |
Code | text |
Status | text |
Consumed At | date |
| Field | Type |
|---|---|
ListRequired | choice |
Emails | array |
Email | |
Contact IDs | array |
Contact ID | number |
| Field | Type |
|---|---|
Contacts | object |
Failure | text |
Process ID | number |
Success | text |
Total | number |
| Field | Type |
|---|---|
ActionRequired | choice |
User EmailRequired |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
User EmailRequired |
| Field | Type |
|---|---|
User EmailRequired |
| Field | Type |
|---|---|
Status | text |
Credit Notes | array |
Credit Note | text |
| Field | Type |
|---|---|
PidRequired | choice |
| Field | Type |
|---|---|
Visitor IDRequired | text |
Message TextRequired | text |
Agent ID | text |
Agent Email | |
Agent Name | text |
| Field | Type |
|---|---|
ID | text |
Text | text |
HTML | text |
Agent ID | text |
Created At | number |
| Field | Type |
|---|---|
Sender | object |
Name | text |
Email | |
ID | number |
ToRequired | array |
Email | |
Name | text |
BCC | array |
Email | |
Name | text |
CC | array |
Email | |
Name | text |
HTML Content | text |
| Field | Type |
|---|---|
Message ID | text |
| Field | Type |
|---|---|
Email CampaignRequired | choice |
| Field | Type |
|---|---|
Email CampaignRequired | choice |
Language | choice |
EmailRequired | object |
To | array |
| Field | Type |
|---|---|
Email CampaignRequired | choice |
Email To | array |
Email |
| Field | Type |
|---|---|
Agent ID | text |
Agent Email | |
Agent Name | text |
Received From | text |
Visitor IDRequired | text |
| Field | Type |
|---|---|
ID | text |
Text | text |
Created At | number |
| Field | Type |
|---|---|
SenderRequired | text |
RecipientRequired | text |
Content | text |
Template | choice |
Type | choice |
| Field | Type |
|---|---|
Message ID | number |
Reference | text |
SMS Count | number |
Used Credits | number |
Remaining Credits | number |
| Field | Type |
|---|---|
SenderRequired | text |
RecipientRequired | text |
Content | text |
Template | choice |
Type | choice |
| Field | Type |
|---|---|
Message ID | number |
| Field | Type |
|---|---|
SMS CampaignRequired | choice |
| Field | Type |
|---|---|
SMS CampaignRequired | choice |
Language | choice |
EmailRequired | object |
To | array |
| Field | Type |
|---|---|
SMS CampaignRequired | choice |
Phone Number | text |
| Field | Type |
|---|---|
TemplateRequired | choice |
Email To | array |
Email |
| Field | Type |
|---|---|
Sender NumberRequired | text |
Recipient NumbersRequired | array |
Phone Number | text |
Template IDRequired | number |
Params | object |
| Field | Type |
|---|---|
Message ID | text |
| Field | Type |
|---|---|
CurrencyRequired | text |
| Field | Type |
|---|---|
Code | text |
| Field | Type |
|---|---|
Email CampaignRequired | choice |
StatusRequired | choice |
| Field | Type |
|---|---|
Product IDRequired | choice |
Alert TypeRequired | choice |
Enabled | boolean |
| Field | Type |
|---|---|
SMS CampaignRequired | choice |
StatusRequired | choice |
| Field | Type |
|---|---|
Template IDRequired | number |
| Field | Type |
|---|---|
PidRequired | choice |
Contact ID | choice |
Loyalty Subscription ID | choice |
Member Contact IdsRequired | array |
Member Contact Ids | number |
| Field | Type |
|---|---|
Organization ID | number |
Owner Contact ID | number |
Member Contact Ids | array |
Member Contact ID | number |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
PidRequired | choice |
Contact IDRequired | choice |
Loyalty Subscription ID | choice |
Creation Date | text |
Meta | object |
| Field | Type |
|---|---|
Organization ID | number |
Loyalty Program ID | text |
Version ID | number |
Contact ID | number |
Loyalty Subscription ID | text |
| Field | Type |
|---|---|
Sub-AccountRequired | choice |
Automation | boolean |
Conversations | boolean |
Sales CRM | boolean |
Email Campaigns | boolean |
| Field | Type |
|---|---|
DomainRequired | text |
| Field | Type |
|---|---|
GroupRequired | choice |
Sub-Account IDsRequired | array |
Sub-Account | choice |
| Field | Type |
|---|---|
Attribute CategoryRequired | choice |
Attribute NameRequired | text |
Value | text |
Enumeration | array |
Value | number |
Label | text |
Multi Category Options | array |
Option | text |
| Field | Type |
|---|---|
PidRequired | choice |
BdidRequired | choice |
Balance Availability Duration Modifier | text |
Balance Availability Duration Unit | text |
Balance Availability Duration Value | number |
| Field | Type |
|---|---|
ID | text |
Name | text |
Description | text |
Image Ref | url |
Meta | object |
| Field | Type |
|---|---|
PidRequired | choice |
BdidRequired | choice |
BlidRequired | choice |
Constraint TypeRequired | text |
Duration UnitRequired | text |
| Field | Type |
|---|---|
ID | text |
Balance Definition ID | text |
Transaction Type | text |
Constraint Type | text |
Duration Value | number |
| Field | Type |
|---|---|
CompanyRequired | choice |
Attributes | object |
Link Contact IDs | array |
Contact ID | number |
Unlink Contact IDs | array |
Contact ID | number |
Link Deal IDs | array |
Deal ID | text |
| Field | Type |
|---|---|
Attributes | object |
ID | text |
Linked Contacts Ids | array |
Linked Contacts Ids | number |
Linked Deals Ids | array |
Linked Deals Ids | text |
| Field | Type |
|---|---|
IdentifierRequired | text |
Identifier Type | choice |
Attributes | object |
Email Blacklisted | boolean |
SMS Blacklisted | boolean |
| Field | Type |
|---|---|
Message IDRequired | text |
Text | text |
| Field | Type |
|---|---|
ID | text |
Text | text |
| Field | Type |
|---|---|
Group IDRequired | choice |
| Field | Type |
|---|---|
Group ID | text |
Visitor ID | text |
| Field | Type |
|---|---|
User EmailRequired | |
All Features AccessRequired | boolean |
Privileges | array |
Feature | choice |
Permissions | array |
| Field | Type |
|---|---|
Coupon CollectionRequired | choice |
Default Coupon | text |
Expiration Date | date |
Remaining Coupons Alert | number |
Remaining Days Alert | number |
| Field | Type |
|---|---|
ID | text |
Name | text |
Default Coupon | text |
| Field | Type |
|---|---|
Attribute IDRequired | text |
Label | text |
| Field | Type |
|---|---|
DealRequired | choice |
Attributes | object |
Linked Contact IDs | array |
Contact | choice |
Linked Company IDs | array |
Company | choice |
Unlinked Contact IDs | array |
Contact | choice |
| Field | Type |
|---|---|
Email CampaignRequired | choice |
Name | text |
Subject | text |
Sender | object |
Name | text |
Email | |
ID | number |
HTML Content | text |
| Field | Type |
|---|---|
External FeedRequired | choice |
Name | text |
URL | url |
Auth Type | choice |
Username | text |
| Field | Type |
|---|---|
FolderRequired | choice |
NameRequired | text |
| Field | Type |
|---|---|
GroupRequired | choice |
Group Name | text |
Sub-Account IDs | array |
Sub-Account | choice |
| Field | Type |
|---|---|
ListRequired | choice |
Name | text |
Folder | choice |
| Field | Type |
|---|---|
Loyalty ProgramRequired | choice |
NameRequired | text |
Description | text |
Meta | object |
| Field | Type |
|---|---|
ID | text |
Name | text |
| Field | Type |
|---|---|
Note IDRequired | choice |
Text | text |
Contact IDs | array |
Contact | choice |
Company IDs | array |
Company | choice |
Deal IDs | array |
Deal | choice |
| Field | Type |
|---|---|
User EmailRequired | |
All Features AccessRequired | boolean |
PrivilegesRequired | array |
Feature | choice |
Permissions | array |
| Field | Type |
|---|---|
Status | text |
Invoice ID | text |
Credit Notes | array |
Credit Note | text |
| Field | Type |
|---|---|
User EmailRequired | |
All Features AccessRequired | boolean |
PrivilegesRequired | array |
Feature | choice |
Permissions | array |
| Field | Type |
|---|---|
Credit Notes | array |
Credit Notes | text |
Invoice ID | text |
Status | text |
| Field | Type |
|---|---|
Message IDRequired | text |
Message Text | text |
| Field | Type |
|---|---|
ID | text |
Text | text |
| Field | Type |
|---|---|
SenderRequired | choice |
Name | text |
Email | |
IPs | array |
IP | text |
Domain | text |
Weight | number |
| Field | Type |
|---|---|
SMS CampaignRequired | choice |
Name | text |
Sender | text |
Content | text |
Recipients | object |
List IDs | array |
Exclusion List IDs | array |
| Field | Type |
|---|---|
Sub-AccountRequired | choice |
Credits | object |
Email Credits | number |
SMS Credits | number |
WhatsApp Credits | number |
WP Subscribers Credits | number |
External Feeds Credits | number |
Features | object |
Inbox | number |
Landing Pages | number |
Sales Users | number |
Users | number |
| Field | Type |
|---|---|
Task IDRequired | choice |
Name | text |
Task Type | choice |
Due Date | date |
Duration (ms) | number |
| Field | Type |
|---|---|
TemplateRequired | choice |
Template Name | text |
Subject | text |
Sender | object |
Name | text |
Email | |
ID | number |
HTML Content | text |
| Field | Type |
|---|---|
Loyalty ProgramRequired | choice |
Tier IDRequired | text |
NameRequired | text |
Access ConditionsRequired | array |
Balance Definition ID | text |
Minimum Value | number |
Tier RewardsRequired | array |
Reward ID | text |
| Field | Type |
|---|---|
ID | text |
Name | text |
| Field | Type |
|---|---|
Loyalty ProgramRequired | choice |
Tier Group IDRequired | text |
NameRequired | text |
Upgrade StrategyRequired | choice |
Downgrade StrategyRequired | choice |
| Field | Type |
|---|---|
ID | text |
Name | text |
| Field | Type |
|---|---|
WebhookRequired | choice |
URL | url |
Description | text |
Events | array |
Event | choice |
Domain | text |
| Field | Type |
|---|---|
Campaign IDRequired | choice |
Campaign Name | text |
Campaign Status | text |
Recipients | object |
Reschedule For | text |
| Field | Type |
|---|---|
FileRequired | text |
FilenameRequired | text |
Contact ID | number |
Deal ID | text |
Company ID | text |
| Field | Type |
|---|---|
ID | text |
Name | text |
Size | number |
| Field | Type |
|---|---|
Image FileRequired | text |
FilenameRequired | text |
| Field | Type |
|---|---|
Image URL | url |
| Field | Type |
|---|---|
Object TypeRequired | text |
RecordsRequired | array |
Identifiers | object |
Attributes | object |
Associations | array |
| Field | Type |
|---|---|
Message | text |
Process ID | number |
| Field | Type |
|---|---|
PidRequired | choice |
Attributed Reward ID | choice |
Code | text |
Contact ID | choice |
Loyalty Subscription ID | choice |
| Field | Type |
|---|---|
Authorize | boolean |
| Field | Type |
|---|---|
SenderRequired | choice |
OTPRequired | number |



