Brevo

Email, SMS, and marketing automation platform (formerly Sendinblue).

21 triggers112 searches174 actionsPollingAuth: API key

AI-assisted documentation53 min read

This documentation is compiled from our integration source code, internal specs for Brevo, its official API documentation and anonymized requests logs we collect from our support team[2].

Open Brevo on WEXTL →

Requirements

Before you set up the credential, make sure you have an active Brevo account and an API access token from your account settings ready.[3]

Get your Brevo credentials

API KeypasswordRequired
Your API key. Find it in your account under SMTP & API Keys.
[1]

Connect Brevo in WEXTL

Log in to your WEXTL account, add the Brevo node module to your workflow, and click Create new credential.
Optional: In the Credential name field, enter a name for the credential.
Enter the authentication credentials you copied from your Brevo account, or follow the on-screen instructions to create the credential.
If prompted, authenticate your account and confirm access.
If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Connecting Brevo to WEXTL® — Video slide demonstrates how to integrate Brevo in the WEXTL visual workflow builder.[4]

Video slide demonstrates how to integrate Brevo in the WEXTL visual workflow builder.[4]

Notes

Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →

Brevo node modules

The list below is a reference of every Brevo node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.

Each Brevo node module below opens to reveal its input parameters, outputs, and connection requirements.

Output fields[3]

Field	Type
Action	text
Date	date
User Agent	text
User Email	email
User IP	text

Output fields[3]

Field	Type
ID	number
Name	text
Subject	text
Status	text
Type	text

2other output fields

Output fields[3]

Field	Type
Date	date
Email	email
Event	text
From	email
Message ID	text

2other output fields

Output fields[3]

Field	Type
UUID	text
Sender	email
Recipient	email
Date	date

Output fields[3]

Field	Type
ID	text
Name	text
URL	url
Created At	date
Modified At	date

Output fields[3]

Field	Type
ID	number
Email	email
Email Blacklisted	boolean
SMS Blacklisted	boolean
Created At	date

3other output fields

Output fields[3]

Field	Type
Created At	date
Default Coupon	text
Expiration Date	date
ID	text
Name	text

4other output fields

Output fields[3]

Field	Type
ID	text
Name	text
Author ID	text
Contact ID	number
Deal ID	text

3other output fields

Output fields[3]

Field	Type
Date	date
Email	email
From	email
Message ID	text
Subject	text

3other output fields

Output fields[3]

Field	Type
ID	text
Name	text
URL	url
Auth Type	text
Created At	date

1other output field

Output fields[3]

Field	Type
ID	number
Name	text
Total Blacklisted	number
Total Subscribers	number
Unique Subscribers	number

Output fields[3]

Field	Type
ID	number
Name	text
Total Blacklisted	number
Total Subscribers	number
Unique Subscribers	number

Output fields[3]

Field	Type
Contacts	array
Attributes	object
Created At	date
Email	email
Email Blacklisted	boolean
ID	number
List Ids	array
List Unsubscribed	array
Modified At	date
SMS Blacklisted	boolean
Whatsapp Blacklisted	boolean
Count	number

Output fields[3]

Field	Type
Count	number
Lists	array
ID	number
Name	text
Total Blacklisted	number
Total Subscribers	number
Unique Subscribers	number
Folder ID	number

Output fields[3]

Field	Type
ID	text
Text	text
Contact Ids	array
Contact Ids	number
Company Ids	array
Company Ids	text
Deal Ids	array
Deal Ids	text

3other output fields

Output fields[3]

Field	Type
ID	number
Name	text
Status	text
Info	object
Import	object
Export URL	url

Output fields[3]

Field	Type
Brand	text
Categories	array
Categories	text
Created At	date
Description	text
ID	text

14other output fields

Output fields[3]

Field	Type
Category Name	text
ID	number
Segment Name	text
Updated At	date

Output fields[3]

Field	Type
Active	boolean
Email	text
ID	number
Ips	array
Name	text

Output fields[3]

Field	Type
Date	date
Event	text
Message ID	text
Phone Number	text
Reason	text

2other output fields

Output fields[3]

Field	Type
ID	text
Task Type ID	text
Name	text
Companies Ids	array
Companies Ids	text
Deals Ids	array
Deals Ids	text

7other output fields

Output fields[3]

Field	Type
Organization ID	text
User ID	number
Enterprise	boolean
Company Name	text
Email	email

6other output fields

Input fields[3]

Field	Type
Period From	date
Period To	date
Email Campaign IDs	array
Campaign	choice
SMS Campaign IDs	array
Campaign	choice

Output fields[3]

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

Input fields[3]

Field	Type
Conversion SourceRequired	choice
Conversion Source IDRequired	text

Output fields[3]

Field	Type
Products	array
ID	text
Name	text
Image URL	url
Price	number
Orders Count	number

Input fields[3]

Field	Type
PidRequired	choice
BdidRequired	choice

Output fields[3]

Field	Type
ID	text
Name	text
Description	text
Image Ref	url
Meta	object

15other output fields

Input fields[3]

Field	Type
PidRequired	choice
Limit	number

Output fields[3]

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

Input fields[3]

Field	Type
PidRequired	choice
BdidRequired	choice
BlidRequired	text

Output fields[3]

Field	Type
ID	text
Balance Definition ID	text
Transaction Type	text
Constraint Type	text
Duration Value	number

5other output fields

Input fields[3]

Field	Type
Category IDRequired	choice

Output fields[3]

Field	Type
ID	text
Name	text
URL	url
Created At	date
Modified At	date

Input fields[3]

Field	Type
PidRequired	choice
CpidRequired	text

Output fields[3]

Field	Type
Count	number

Input fields[3]

Field	Type
CompanyRequired	choice

Output fields[3]

Field	Type
ID	text
Attributes	object
Linked Contacts IDs	array
ID	number
Linked Deals IDs	array
ID	text

Input fields[3]

Field	Type
IdentifierRequired	text

Output fields[3]

Field	Type
ID	number
Email	email
Email Blacklisted	boolean
SMS Blacklisted	boolean
Created At	date

3other output fields

Input fields[3]

Field	Type
PidRequired	choice
Limit	number

Output fields[3]

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

Input fields[3]

Field	Type
IdentifierRequired	text
Start Date	text
End Date	text

Output fields[3]

Field	Type
Messages Sent	array
Hard Bounces	array
Soft Bounces	array
Complaints	array
Delivered	array

4other output fields

Input fields[3]

Field	Type
Message IDRequired	text

Output fields[3]

Field	Type
ID	text
Text	text
HTML	text
Agent ID	text
Created At	number

1other output field

Input fields[3]

Field	Type
User EmailRequired	email

Output fields[3]

Field	Type
Email	email
All Features Access	boolean
Privileges	array
Feature	text
Permissions	array

Input fields[3]

Field	Type
Coupon CollectionRequired	choice

Output fields[3]

Field	Type
ID	text
Name	text
Default Coupon	text
Remaining Coupons	number
Total Coupons	number

1other output field

Input fields[3]

Field	Type
File IDRequired	text

Output fields[3]

Field	Type
File URL	url

Input fields[3]

Field	Type
File IDRequired	text

Output fields[3]

Field	Type
ID	text
Name	text
Size	number
Type	text
Created At	date

Input fields[3]

Field	Type
Pipeline IDRequired	text

Output fields[3]

Field	Type
Pipeline ID	text
Pipeline Name	text
Stages	array
Stage ID	text
Stage Name	text

Output fields[3]

Field	Type
Pipeline ID	text
Pipeline Name	text
Stages	array
Stage ID	text
Stage Name	text

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
ID	text
Title	text

Input fields[3]

Field	Type
DealRequired	choice

Output fields[3]

Field	Type
ID	text
Attributes	object
Linked Contacts IDs	array
Contact ID	number
Linked Companies IDs	array
Company ID	text

Output fields[3]

Field	Type
Currency	text

Input fields[3]

Field	Type
Domain NameRequired	text

Output fields[3]

Field	Type
Domain	text
Verified	boolean
Authenticated	boolean
DNS Records	object
Brevo Code	object
DKIM Record	object
DMARC Record	object

Input fields[3]

Field	Type
Email CampaignRequired	choice
Statistics	choice

Output fields[3]

Field	Type
ID	number
Name	text
Subject	text
Type	text
Status	text

3other output fields

Input fields[3]

Field	Type
Email CampaignRequired	choice

Output fields[3]

Field	Type
Winning Version	text
Winning Criteria	text
Winning Subject Line	text
Open Rate	object
Click Rate	object

1other output field

Input fields[3]

Field	Type
Email CampaignRequired	choice

Output fields[3]

Field	Type
Shared URL	url

Input fields[3]

Field	Type
UUIDRequired	choice

Output fields[3]

Field	Type
Date	text
Email	text
Events	array
Subject	text
Body	text

1other output field

Input fields[3]

Field	Type
Start Date	date
End Date	date
Days	number
Tag	text

Output fields[3]

Field	Type
Blocked	number
Clicks	number
Delivered	number
Hard bounces	number
Invalid	number

8other output fields

Input fields[3]

Field	Type
Start Date	text
End Date	text
Days	number
Tag	text
Sort	choice

1other input field

Output fields[3]

Field	Type
Date	date
Requests	number
Delivered	number
Hard Bounces	number
Soft Bounces	number

8other output fields

Input fields[3]

Field	Type
External FeedRequired	choice

Output fields[3]

Field	Type
ID	text
Name	text
URL	url
Auth Type	text
Max Retries	number

3other output fields

Input fields[3]

Field	Type
FolderRequired	choice

Output fields[3]

Field	Type
ID	number
Name	text
Total Blacklisted	number
Total Subscribers	number

Input fields[3]

Field	Type
GroupRequired	choice

Output fields[3]

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	email
First Name	text
Last Name	text

Input fields[3]

Field	Type
UUIDRequired	text

Output fields[3]

Field	Type
Received At	date
Delivered At	date
Sender	email
Recipient	email
Subject	text

3other output fields

Input fields[3]

Field	Type
ListRequired	choice

Output fields[3]

Field	Type
ID	number
Name	text
Folder ID	number
Total Blacklisted	number
Total Subscribers	number

Input fields[3]

Field	Type
Loyalty ProgramRequired	choice
Contact ID	text
Loyalty Subscription ID	text
Include Internal	boolean
Params	text

Output fields[3]

Field	Type
Balance	object
Tiers	array
Rewards	array

Input fields[3]

Field	Type
Loyalty ProgramRequired	choice
Contact ID	number
Loyalty Subscription ID	text
Balance Definition ID	text
Sort Field	text

2other input fields

Output fields[3]

Field	Type
ID	text
Amount	number
Contact ID	number
Loyalty Program ID	text
Balance Definition ID	text

2other output fields

Input fields[3]

Field	Type
PidRequired	choice
RidRequired	choice
Limit	number

Output fields[3]

Field	Type
Attribution Per Consumer	number
Balance Definition ID	text
Code	text
Code Count	number
Code Generator ID	text

35other output fields

Input fields[3]

Field	Type
PidRequired	choice
Limit	number

Output fields[3]

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

Input fields[3]

Field	Type
Loyalty ProgramRequired	choice

Output fields[3]

Field	Type
ID	text
Name	text
Description	text
Document ID	text
Meta	object

Output fields[3]

Field	Type
ID	number
Company Name	text
Email	email
Currency Code	text
Timezone	text

Input fields[3]

Field	Type
User EmailRequired	email

Output fields[3]

Field	Type
Token	text

Input fields[3]

Field	Type
Note IDRequired	choice

Output fields[3]

Field	Type
ID	text
Text	text
Contact IDs	array
Contact ID	number
Company IDs	array
Company ID	text
Deal IDs	array
Deal ID	text

2other output fields

Input fields[3]

Field	Type
User EmailRequired	email

Output fields[3]

Field	Type
Email	email
Status	text
Privileges	array
Feature	text
Permissions	array

Input fields[3]

Field	Type
Payment Request IDRequired	text

Output fields[3]

Field	Type
ID	text
Reference	text
Status	text
Payment URL	url
Amount	number

2other output fields

Input fields[3]

Field	Type
ProcessRequired	choice

Output fields[3]

Field	Type
ID	number
Name	text
Status	text
Export URL	url
Info	object

Input fields[3]

Field	Type
Product IDRequired	choice

Output fields[3]

Field	Type
ID	text
Name	text
Price	number
SKU	text
URL	url

4other output fields

Input fields[3]

Field	Type
Message IDRequired	text

Output fields[3]

Field	Type
ID	text
Text	text
Created At	number

Input fields[3]

Field	Type
Start Date	text
End Date	text
Days	number
Tag	text

Output fields[3]

Field	Type
Range	text
Requests	number
Delivered	number
Hard Bounces	number
Soft Bounces	number

5other output fields

Input fields[3]

Field	Type
SMS CampaignRequired	choice

Output fields[3]

Field	Type
ID	number
Name	text
Status	text
Content	text
Sender	text

3other output fields

Input fields[3]

Field	Type
Start Date	text
End Date	text
Days	number
Tag	text
Sort	choice

1other input field

Output fields[3]

Field	Type
Date	date
Requests	number
Delivered	number
Hard Bounces	number
Soft Bounces	number

5other output fields

Input fields[3]

Field	Type
Conversion SourceRequired	choice
Conversion Source IDRequired	text

Output fields[3]

Field	Type
ID	text
Conversion Source	text
Orders Count	number
Revenue	number
Average Basket	number

1other output field

Input fields[3]

Field	Type
Sub-AccountRequired	choice

Output fields[3]

Field	Type
Company Name	text
Email	email
Name	text
Groups	array
ID	text
Name	text
Plan Info	object
Plan Type	text

Input fields[3]

Field	Type
PidRequired	choice
CidRequired	choice
Limit	number

Output fields[3]

Field	Type
Loyalty Program ID	text
Contact ID	number
Balance	array
Balance Definition ID	text
Value	number

Input fields[3]

Field	Type
Task IDRequired	choice

Output fields[3]

Field	Type
ID	text
Name	text
Task Type ID	text
Due Date	date
Done	boolean

5other output fields

Input fields[3]

Field	Type
TemplateRequired	choice

Output fields[3]

Field	Type
ID	number
Name	text
Subject	text
Is Active	boolean
DOI Template	boolean

8other output fields

Input fields[3]

Field	Type
Loyalty ProgramRequired	choice
Tier GroupRequired	choice
Version	choice

Output fields[3]

Field	Type
ID	text
Name	text
Upgrade Strategy	text
Downgrade Strategy	text
Tier Order	array
Tier ID	text

Input fields[3]

Field	Type
WhatsApp CampaignRequired	choice

Output fields[3]

Field	Type
ID	number
Campaign Name	text
Campaign Status	text
Scheduled At	date
Created At	date

1other output field

Input fields[3]

Field	Type
WebhookRequired	choice

Output fields[3]

Field	Type
ID	number
URL	url
Description	text
Events	array
Event	text
Type	text

4other output fields

Output fields[3]

Field	Type
Phone Number	text
WhatsApp Account ID	text
Created At	date

Input fields[3]

Field	Type
Start Date	text
End Date	text
User Email	email
Limit	number

Output fields[3]

Field	Type
Action	text
Date	date
User Agent	text
User Email	email
User IP	text

Input fields[3]

Field	Type
User Type	choice
Limit	number

Output fields[3]

Field	Type
Email	email
Is Owner	boolean
Status	text
Feature Access	object

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
Category	text
Name	text
Type	text
Enumeration	array
Value	number
Label	text
Multi Category Options	array
Option	text

1other output field

Input fields[3]

Field	Type
Start Date	date
End Date	date
Senders	array
Sender Email	email
Sort	choice
Limit	number

Output fields[3]

Field	Type
Blocked at	date
Email	email
Reason	object
Code	text
Message	text
Sender email	email

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
Domain	text
Created At	date

Input fields[3]

Field	Type
Name Filter	text
Linked Contact IDs	text
Linked Deal IDs	text
Sort	choice
Sort By	text

3other input fields

Output fields[3]

Field	Type
ID	text
Attributes	object
Linked Contacts IDs	array
ID	number
Linked Deals IDs	array
ID	text

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
ID	text
Name	text
Label	text
Type	text

Input fields[3]

Field	Type
Modified Since	date
Created Since	date
Sort	choice
Segment ID	choice
List IDs	array
List	choice

2other input fields

Output fields[3]

Field	Type
ID	number
Email	email
Email Blacklisted	boolean
SMS Blacklisted	boolean
Created At	date

3other output fields

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
IP	text
Domain	text
Transactional	boolean

Input fields[3]

Field	Type
Sort	choice
Sort By	text
Limit	number

Output fields[3]

Field	Type
ID	text
Name	text
Default Coupon	text
Remaining Coupons	number
Total Coupons	number

1other output field

Input fields[3]

Field	Type
Entity Type	choice
Entity IDs	text
Date From (Unix ms)	number
Date To (Unix ms)	number
Sort	choice

1other input field

Output fields[3]

Field	Type
ID	text
Name	text
Size	number
Type	text
Created At	date

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
ID	text
Name	text
Label	text
Type	text

Input fields[3]

Field	Type
Deal Name Filter	text
Linked Companies IDs	text
Linked Contacts IDs	text
Sort	choice
Sort By	text

3other input fields

Output fields[3]

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

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
ID	number
IP	text
Domain	text
Active	boolean

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
ID	text
Domain Name	text
Authenticated	boolean
Verified	boolean
IP	text

2other output fields

Input fields[3]

Field	Type
Type	choice
Status	choice
Statistics	choice
Start Date	text
End Date	text

4other input fields

Output fields[3]

Field	Type
ID	number
Name	text
Subject	text
Type	text
Status	text

4other output fields

Input fields[3]

Field	Type
Start Date	text
End Date	text
Days	number
Email	email
Event Type	choice

5other input fields

Output fields[3]

Field	Type
Date	date
Email	email
Event	text
Message ID	text
From	text

3other output fields

Input fields[3]

Field	Type
Email	email
Template	choice
Message ID	text
Start Date	text
End Date	text

2other input fields

Output fields[3]

Field	Type
Date	date
Email	email
Message ID	text
Subject	text
UUID	text

1other output field

Input fields[3]

Field	Type
Contact ID	number
Event Name	text
Event Filter ID	text
Object Type	text
Start Date	text

2other input fields

Output fields[3]

Field	Type
Contact ID	number
Event Date	date
Event Name	text
Event Filter ID	text
Object Type	text

2other output fields

Input fields[3]

Field	Type
Search	text
Start Date	text
End Date	text
Sort	choice
Auth Type	choice

1other input field

Output fields[3]

Field	Type
ID	text
Name	text
URL	url
Auth Type	text
Username	text

6other output fields

Input fields[3]

Field	Type
FolderRequired	choice
Sort	choice
Limit	number

Output fields[3]

Field	Type
ID	number
Name	text
Folder ID	number
Total Blacklisted	number
Total Subscribers	number

1other output field

Input fields[3]

Field	Type
Sort	choice
Limit	number

Output fields[3]

Field	Type
ID	number
Name	text
Total Blacklisted	number
Total Subscribers	number

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
ID	text
Group Name	text

Input fields[3]

Field	Type
Sender	email
Start Date	text
End Date	text
Sort	choice
Limit	number

Output fields[3]

Field	Type
UUID	text
Sender	email
Recipient	email
Date	date

Input fields[3]

Field	Type
ListRequired	choice
Modified Since	date
Created Since	date
Sort	choice
Limit	number

Output fields[3]

Field	Type
ID	number
Email	email
Email Blacklisted	boolean
SMS Blacklisted	boolean
Created At	date

2other output fields

Input fields[3]

Field	Type
Sort	choice
Limit	number

Output fields[3]

Field	Type
ID	number
Name	text
Folder ID	number
Total Blacklisted	number
Total Subscribers	number

2other output fields

Input fields[3]

Field	Type
Sort Field	text
Sort Order	choice
Limit	number

Output fields[3]

Field	Type
ID	text
Name	text
Description	text
Document ID	text
Meta	object

Input fields[3]

Field	Type
Loyalty ProgramRequired	choice
State	text
Version	choice
Limit	number

Output fields[3]

Field	Type
ID	text
Name	text
Loyalty Program ID	text
State	text
Start Date	date

4other output fields

Input fields[3]

Field	Type
Loyalty ProgramRequired	choice
Contact IDRequired	number
Balance Definition IDRequired	text
Status	choice
Transaction Type	choice

4other input fields

Output fields[3]

Field	Type
ID	text
Amount	number
Transaction Type	text
Status	text
Created At	date

3other output fields

Input fields[3]

Field	Type
Entity Type	choice
Entity IDs	text
Date From (Unix ms)	number
Date To (Unix ms)	number
Sort	choice

1other input field

Output fields[3]

Field	Type
ID	text
Text	text
Contact IDs	array
Contact ID	number
Company IDs	array
Company ID	text
Deal IDs	array
Deal ID	text

3other output fields

Input fields[3]

Field	Type
Object TypeRequired	text
Sort	choice
Include Associations	choice
Limit	number

Output fields[3]

Field	Type
Identifiers	object
ID	number
External ID	text
Attributes	object
Associations	array
Created At	date
Updated At	date

Input fields[3]

Field	Type
Modified Since	date
Created Since	date
Sort	choice
Limit	number

Output fields[3]

Field	Type
ID	text
Status	text
Amount	number
Contact Email	email
Created At	date

1other output field

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
Email	email
Is Owner	boolean
Status	text
Feature Access	object

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
Pipeline ID	text
Pipeline Name	text
Stages	array
Stage ID	text
Stage Name	text

Input fields[3]

Field	Type
Sort	choice
Limit	number

Output fields[3]

Field	Type
ID	number
Name	text
Status	text
Export URL	url
Info	object
Import	object

Input fields[3]

Field	Type
Product IDs	array
ID	text
Name	text
Max Price	number
Min Price	number
Sort	choice

4other input fields

Output fields[3]

Field	Type
ID	text
Name	text
Price	number
SKU	text
Image URL	url

4other output fields

Input fields[3]

Field	Type
Batch ID or Message IDRequired	choice
Start Date	date
End Date	date
Sort	choice
Status	choice

1other input field

Output fields[3]

Field	Type
Scheduled At	date
Created At	date
Status	text

Input fields[3]

Field	Type
Sort	choice
Limit	number

Output fields[3]

Field	Type
ID	number
Segment Name	text
Created At	date
Recipients Count	number

Input fields[3]

Field	Type
SenderRequired	choice
Limit	number

Output fields[3]

Field	Type
ID	number
IP	text
Domain	text
Weight	number

Input fields[3]

Field	Type
IP	text
Domain	text
Limit	number

Output fields[3]

Field	Type
ID	number
Name	text
Email	email
Active	boolean
IPs	array
IP	text
Domain	text
Weight	number

Input fields[3]

Field	Type
Status	choice
Start Date	text
End Date	text
Sort	choice
Limit	number

Output fields[3]

Field	Type
ID	number
Name	text
Status	text
Content	text
Sender	text

3other output fields

Input fields[3]

Field	Type
Start Date	text
End Date	text
Days	number
Phone Number	text
Event Type	choice

3other input fields

Output fields[3]

Field	Type
Phone Number	text
Date	date
Message ID	text
Event	text
Reason	text

2other output fields

Input fields[3]

Field	Type
Search	text
Sort	choice
Limit	number

Output fields[3]

Field	Type
ID	number
Name	text
Content	text
Sender	text
Tag	text

2other output fields

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
ID	number
Company Name	text
Email	email

Input fields[3]

Field	Type
Task Type	choice
Status Filter	choice
Date Filter	choice
Assign To Filter	text
Contacts Filter	text

7other input fields

Output fields[3]

Field	Type
ID	text
Name	text
Task Type ID	text
Due Date	date
Done	boolean

8other output fields

Input fields[3]

Field	Type
Active Templates Only	boolean
Editor Type	choice
Sort	choice
Limit	number

Output fields[3]

Field	Type
Created at	date
HTML content	text
ID	number
Is active	boolean
Modified at	date

7other output fields

Input fields[3]

Field	Type
Loyalty ProgramRequired	choice
Limit	number

Output fields[3]

Field	Type
ID	text
Name	text
Upgrade Strategy	text
Downgrade Strategy	text
Tier Order	array
Tier ID	text

Input fields[3]

Field	Type
Loyalty ProgramRequired	choice
Version	choice
Limit	number

Output fields[3]

Field	Type
ID	text
Name	text
Access Conditions	array
Balance Definition ID	text
Minimum Value	number

Input fields[3]

Field	Type
Start Date	text
End Date	text
Sort	choice
Limit	number

Output fields[3]

Field	Type
ID	number
Campaign Name	text
Campaign Status	text
Scheduled At	date
Template ID	number

6other output fields

Input fields[3]

Field	Type
Type	choice
Sort	choice
Limit	number

Output fields[3]

Field	Type
ID	number
URL	url
Description	text
Events	array
Event	text
Type	text

6other output fields

Input fields[3]

Field	Type
Start Date	text
End Date	text
Sort	choice
Event Type	choice
Contact Number	text

1other input field

Output fields[3]

Field	Type
Date	date
Contact Number	text
Event	text
Message ID	text
Template ID	number

Input fields[3]

Field	Type
Start Date	text
End Date	text
Sort	choice
Limit	number

Output fields[3]

Field	Type
ID	number
Name	text
Status	text
Language	text
Category	text

1other output field

No fields documented.

Input fields[3]

Field	Type
PidRequired	choice
CidRequired	choice
TidRequired	choice

Output fields[3]

Field	Type
Contact ID	number
Created At	date
Group ID	text
ID	text
Loyalty Program ID	text

2other output fields

Input fields[3]

Field	Type
ListRequired	choice
Emails	array
Email	email
Contact IDs	array
Contact ID	number

Output fields[3]

Field	Type
Contacts	object
Failure	text
Process ID	number
Success	text
Total	number

Input fields[3]

Field	Type
IP AddressRequired	text
Sub-Account IDsRequired	array
Sub-Account	choice

Input fields[3]

Field	Type
Loyalty ProgramRequired	choice
Reward IDRequired	text
Contact ID	number
Loyalty Subscription ID	text
Code	text

4other input fields

Output fields[3]

Field	Type
ID	text
Code	text
Contact ID	number
Reward ID	text
Value	number

2other output fields

Input fields[3]

Field	Type
Domain NameRequired	text

Output fields[3]

Field	Type
Domain Name	text
Message	text

Input fields[3]

Field	Type
CategoriesRequired	array
Category ID	text
Name	text
URL	url
Deleted At	text
Update Enabled	boolean

Output fields[3]

Field	Type
Created Count	number
Updated Count	number

Input fields[3]

Field	Type
EventsRequired	array
Event Name	text
Identifiers	object
Event Date	text
Event Properties	object
Contact Properties	object
Object	object

Output fields[3]

Field	Type
Message	text
Count	number

Input fields[3]

Field	Type
OrdersRequired	array
Order ID	text
Status	choice
Amount	number
Email	email
Created At	date
Updated At	date

Output fields[3]

Field	Type
Batch ID	number
Count	number

Input fields[3]

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

Output fields[3]

Field	Type
Created Count	number
Updated Count	number

Input fields[3]

Field	Type
ContactsRequired	array
Email	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

Input fields[3]

Field	Type
DomainRequired	text

Input fields[3]

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

Input fields[3]

Field	Type
Loyalty ProgramRequired	choice
Transaction IDRequired	text

Output fields[3]

Field	Type
ID	text
Status	text
Amount	number

Input fields[3]

Field	Type
Loyalty ProgramRequired	choice
Transaction IDRequired	text

Output fields[3]

Field	Type
ID	text
Status	text
Amount	number

Input fields[3]

Field	Type
PidRequired	choice
TidRequired	text

Output fields[3]

Field	Type
Cancelled At	date
Completed At	date
Contact ID	number
Created At	date
Debit Transaction ID	text

9other output fields

Input fields[3]

Field	Type
Attribute CategoryRequired	choice
Attribute NameRequired	text
Type	choice
Value	text
Enumeration	array
Value	number
Label	text

1other input field

Input fields[3]

Field	Type
PidRequired	choice
BdidRequired	choice
Constraint TypeRequired	text
Duration UnitRequired	text
Duration ValueRequired	number

3other input fields

Output fields[3]

Field	Type
ID	text
Balance Definition ID	text
Transaction Type	text
Constraint Type	text
Duration Value	number

5other output fields

Input fields[3]

Field	Type
PidRequired	choice
AmountRequired	number
Balance Definition IDRequired	choice
Contact IDRequired	choice
Due AtRequired	text

3other input fields

Output fields[3]

Field	Type
Amount	number
Balance Definition ID	text
Contact ID	number
Created At	date
Due At	date

7other output fields

Input fields[3]

Field	Type
Email	email
External ID	text
Attributes	object
Email Blacklisted	boolean
SMS Blacklisted	boolean

5other input fields

Output fields[3]

Field	Type
ID	number

Input fields[3]

Field	Type
NameRequired	text
Default CouponRequired	text
Expiration Date	date
Remaining Coupons Alert	number
Remaining Days Alert	number

Output fields[3]

Field	Type
ID	text

Input fields[3]

Field	Type
Coupon CollectionRequired	choice
CouponsRequired	array
Coupon Code	text

Input fields[3]

Field	Type
Attribute TypeRequired	text
Description	text
LabelRequired	text
Object TypeRequired	text
Options Labels	array
Options Labels	text

Output fields[3]

Field	Type
ID	text

Input fields[3]

Field	Type
Company NameRequired	text
Attributes	object
Linked Contact IDs	array
Contact	choice
Linked Deal IDs	array
Deal	choice

Output fields[3]

Field	Type
ID	text

Input fields[3]

Field	Type
Deal NameRequired	text
Attributes	object
Linked Contact IDs	array
Contact	choice
Linked Company IDs	array
Company	choice

Output fields[3]

Field	Type
ID	text

Input fields[3]

Field	Type
EmailRequired	email
DOI TemplateRequired	choice
Redirection URLRequired	url
Include List IDsRequired	array
List	choice
Exclude List IDs	array
List	choice

1other input field

Input fields[3]

Field	Type
Domain NameRequired	text

Output fields[3]

Field	Type
ID	text
Domain Name	text
Domain Provider	text
Message	text
DNS Records	object
Brevo Code	object
DKIM Record	object
DMARC Record	object

Input fields[3]

Field	Type
NameRequired	text
Subject	text
SenderRequired	object
Name	text
Email	email
ID	number
TypeRequired	choice
HTML Content	text

31other input fields

Output fields[3]

Field	Type
ID	number

Input fields[3]

Field	Type
Event NameRequired	text
IdentifiersRequired	object
Contact ID	number
Email ID	email
External ID	text
Phone ID	text
WhatsApp ID	text
Landline Number ID	text
Event Date	date
Event Properties	object
Contact Properties	object

1other input field

Input fields[3]

Field	Type
NameRequired	text
URLRequired	url
Auth Type	choice
Username	text
Password	secret

4other input fields

Output fields[3]

Field	Type
ID	text

Input fields[3]

Field	Type
NameRequired	text

Output fields[3]

Field	Type
ID	number

Input fields[3]

Field	Type
Group NameRequired	text
Sub-Account IDs	array
Sub-Account	choice

Output fields[3]

Field	Type
ID	text

Input fields[3]

Field	Type
NameRequired	text
FolderRequired	choice

Output fields[3]

Field	Type
ID	number

Input fields[3]

Field	Type
PidRequired	choice
Balance Availability Duration Modifier	text
Balance Availability Duration Unit	text
Balance Availability Duration Value	number
Balance Expiration Date	text

12other input fields

Output fields[3]

Field	Type
ID	text
Name	text
Description	text
Image Ref	url
Meta	object

15other output fields

Input fields[3]

Field	Type
PidRequired	choice
CidRequired	choice
Balance Definition IDRequired	choice

Output fields[3]

Field	Type
ID	text
Amount	number
Loyalty Program ID	text
Organization ID	number
Contact ID	number

4other output fields

Input fields[3]

Field	Type
NameRequired	text
Description	text
Document ID	text
Meta	object

Output fields[3]

Field	Type
ID	text
Name	text

Input fields[3]

Field	Type
Loyalty ProgramRequired	choice
NameRequired	text
Public Name	text
Public Description	text
Public Image URL	url

Output fields[3]

Field	Type
ID	text
Name	text
Loyalty Program ID	text
Created At	date

Input fields[3]

Field	Type
Loyalty ProgramRequired	choice
AmountRequired	number
Balance Definition IDRequired	text
Transaction Type	choice
Contact ID	number

6other input fields

Output fields[3]

Field	Type
ID	text
Amount	number
Transaction Type	text
Status	text
Contact ID	number

2other output fields

Input fields[3]

Field	Type
TextRequired	text
Contact IDs	array
Contact	choice
Company IDs	array
Company	choice
Deal IDs	array
Deal	choice

Output fields[3]

Field	Type
ID	text

Input fields[3]

Field	Type
Category IDRequired	choice
Name	text
URL	url
Update Enabled	boolean
Deleted At	text

Output fields[3]

Field	Type
ID	text

Input fields[3]

Field	Type
Order IDRequired	text
StatusRequired	choice
AmountRequired	number
Customer Email	email
Billing	object
Address	text
City	text
Country Code	text
Zip Code	text

4other input fields

Input fields[3]

Field	Type
Product IDRequired	choice
NameRequired	text
URL	url
Image URL	url
SKU	text

5other input fields

Output fields[3]

Field	Type
ID	text

Input fields[3]

Field	Type
ReferenceRequired	text
CartRequired	object
Items	array
Contact ID	number
Contact Email	email
Description	text

2other input fields

Output fields[3]

Field	Type
ID	text
Status	text
Payment URL	url

Input fields[3]

Field	Type
NameRequired	text
EmailRequired	email
IPs	array
IP	text
Domain	text
Weight	number

Output fields[3]

Field	Type
ID	number
DKIM Error	boolean
SPF Error	boolean

Input fields[3]

Field	Type
NameRequired	text
SenderRequired	text
ContentRequired	text
Recipients	object
List IDs	array
Exclusion List IDs	array
Scheduled At	date

3other input fields

Output fields[3]

Field	Type
ID	number

Input fields[3]

Field	Type
Company NameRequired	text
EmailRequired	email
Language	choice
Timezone	text
Group IDs	array
Group	choice

Output fields[3]

Field	Type
ID	number

Input fields[3]

Field	Type
Sub-AccountRequired	choice
Key NameRequired	text

Output fields[3]

Field	Type
API Key	text
Status	text

Input fields[3]

Field	Type
NameRequired	text
Task TypeRequired	choice
Due DateRequired	date
Duration (ms)	number
Assign To	text

6other input fields

Output fields[3]

Field	Type
ID	text

Input fields[3]

Field	Type
Template NameRequired	text
SubjectRequired	text
SenderRequired	object
Name	text
Email	email
ID	number
HTML Content	text
HTML URL	url

5other input fields

Output fields[3]

Field	Type
ID	number

Input fields[3]

Field	Type
Loyalty ProgramRequired	choice
Tier Group IDRequired	text
Name	text
Access Conditions	array
Balance Definition ID	text
Minimum Value	number
Meta	object

Output fields[3]

Field	Type
ID	text
Name	text

Input fields[3]

Field	Type
Loyalty ProgramRequired	choice
NameRequired	text
Upgrade Strategy	choice
Downgrade Strategy	choice
Tier Order	array
Tier ID	text

3other input fields

Output fields[3]

Field	Type
ID	text
Name	text

Input fields[3]

Field	Type
URLRequired	url
Description	text
EventsRequired	array
Event	choice
TypeRequired	choice
Domain	text

3other input fields

Output fields[3]

Field	Type
ID	number

Input fields[3]

Field	Type
NameRequired	text
RecipientsRequired	object
Scheduled AtRequired	text
Template IDRequired	choice

Input fields[3]

Field	Type
Template NameRequired	text
LanguageRequired	text
CategoryRequired	choice
Body TextRequired	text
Header Text	text

Output fields[3]

Field	Type
ID	number
Name	text

Input fields[3]

Field	Type
Attribute CategoryRequired	choice
Attribute NameRequired	text

Input fields[3]

Field	Type
Attribute TypeRequired	choice
Multiple Choice AttributeRequired	text
Option to DeleteRequired	text

Input fields[3]

Field	Type
PidRequired	choice
BdidRequired	choice

Input fields[3]

Field	Type
PidRequired	choice
BdidRequired	choice
BlidRequired	text

Input fields[3]

Field	Type
EmailRequired	email

Input fields[3]

Field	Type
CompanyRequired	choice

Input fields[3]

Field	Type
IdentifierRequired	text

Input fields[3]

Field	Type
PidRequired	choice

Input fields[3]

Field	Type
PidRequired	choice
CidRequired	choice

Input fields[3]

Field	Type
Message IDRequired	text

Input fields[3]

Field	Type
IDRequired	text

Input fields[3]

Field	Type
File IDRequired	text

Input fields[3]

Field	Type
DealRequired	choice

Input fields[3]

Field	Type
Domain NameRequired	text

Input fields[3]

Field	Type
Email CampaignRequired	choice

Input fields[3]

Field	Type
IdentifierRequired	choice
From Date	date
To Date	date

Input fields[3]

Field	Type
External FeedRequired	choice

Input fields[3]

Field	Type
FolderRequired	choice

Input fields[3]

Field	Type
GroupRequired	choice

Input fields[3]

Field	Type
Start Date	text
End Date	text
Contact Email	email

Input fields[3]

Field	Type
ListRequired	choice

Input fields[3]

Field	Type
Loyalty ProgramRequired	choice

Input fields[3]

Field	Type
Note IDRequired	choice

Input fields[3]

Field	Type
Object TypeRequired	text
IdentifiersRequired	object
IDs	array
External IDs	array

Output fields[3]

Field	Type
Process ID	number

Input fields[3]

Field	Type
Payment Request IDRequired	text

Input fields[3]

Field	Type
Message IDRequired	text

Input fields[3]

Field	Type
Batch ID or Message IDRequired	choice

Input fields[3]

Field	Type
SenderRequired	choice

Input fields[3]

Field	Type
Campaign IDRequired	choice

Input fields[3]

Field	Type
Sub-AccountRequired	choice

Input fields[3]

Field	Type
Task IDRequired	choice

Input fields[3]

Field	Type
TemplateRequired	choice

Input fields[3]

Field	Type
Loyalty ProgramRequired	choice
Tier IDRequired	text

Input fields[3]

Field	Type
Loyalty ProgramRequired	choice
Tier Group IDRequired	text

Input fields[3]

Field	Type
WebhookRequired	choice

Input fields[3]

Field	Type
Campaign IDRequired	choice

Input fields[3]

Field	Type
IP AddressRequired	text
Sub-Account IDsRequired	array
Sub-Account	choice

Input fields[3]

Field	Type
Download TokenRequired	text

Output fields[3]

Field	Type
File Data	text

Input fields[3]

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

3other input fields

Output fields[3]

Field	Type
Process ID	number

Input fields[3]

Field	Type
Email CampaignRequired	choice
Recipients TypeRequired	choice
Notify URL	url

Output fields[3]

Field	Type
Process ID	number

Input fields[3]

Field	Type
SMS CampaignRequired	choice
Recipients TypeRequired	choice
Notify URL	url

Output fields[3]

Field	Type
Process ID	number

Input fields[3]

Field	Type
Event TypeRequired	choice
Notify URLRequired	url
Webhook TypeRequired	choice
Days	number
Start Date	text

5other input fields

Output fields[3]

Field	Type
Process ID	number

Input fields[3]

Field	Type
Sub-AccountRequired	choice
User Email	email
Target Page	choice
Target URL	url

Output fields[3]

Field	Type
Token	text

Input fields[3]

Field	Type
File URLRequired	url
Column Mapping	object

Output fields[3]

Field	Type
Process ID	number

Input fields[3]

Field	Type
File URL	url
File Body	text
JSON Body	array
Email	email
Attributes	object
List IDs	array
List	choice
New List	object
List Name	text
Folder	choice

5other input fields

Output fields[3]

Field	Type
Process ID	number

Input fields[3]

Field	Type
File URLRequired	url
Column Mapping	object

Output fields[3]

Field	Type
Process ID	number

Input fields[3]

Field	Type
EmailRequired	email
All Features AccessRequired	boolean
Group IDs	array
Group	choice
Privileges	array
Feature	text
Permissions	array

Output fields[3]

Field	Type
ID	text

Input fields[3]

Field	Type
EmailRequired	email
All Features AccessRequired	boolean
Privileges	array
Feature	choice
Permissions	array

Output fields[3]

Field	Type
Status	text
Invoice ID	text

Input fields[3]

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

Input fields[3]

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

Input fields[3]

Field	Type
URLRequired	text
MethodRequired	choice
Headers	array
Header	object
Query String	array
Parameter	object
Body	text

Output fields[3]

Field	Type
Body	text
Headers	object
Status code	number

Input fields[3]

Field	Type
ActionRequired	choice
User EmailRequired	email

Output fields[3]

Field	Type
Status	text
Credit Notes	array
Credit Note	text

Input fields[3]

Field	Type
Loyalty ProgramRequired	choice
Name	text
Description	text
Meta	object

Output fields[3]

Field	Type
ID	text
Name	text

Input fields[3]

Field	Type
Agent ID	text
Agent Email	email
Agent Name	text
Received From	text

Input fields[3]

Field	Type
TemplateRequired	choice
Contact Email	email
Params	object

Output fields[3]

Field	Type
From Email	email
From Name	text
HTML	text
Preview Text	text
Subject	text

1other output field

Input fields[3]

Field	Type
PidRequired	choice

Input fields[3]

Field	Type
Loyalty ProgramRequired	choice
Attributed Reward ID	text
Redemption Code	text
Contact ID	number
Loyalty Subscription ID	text

2other input fields

Output fields[3]

Field	Type
ID	text
Code	text
Status	text
Consumed At	date

Input fields[3]

Field	Type
ListRequired	choice
Emails	array
Email	email
Contact IDs	array
Contact ID	number

Output fields[3]

Field	Type
Contacts	object
Failure	text
Process ID	number
Success	text
Total	number

Input fields[3]

Field	Type
ActionRequired	choice
User EmailRequired	email

Output fields[3]

Field	Type
Message	text

Input fields[3]

Field	Type
User EmailRequired	email

Input fields[3]

Field	Type
User EmailRequired	email

Output fields[3]

Field	Type
Status	text
Credit Notes	array
Credit Note	text

Input fields[3]

Field	Type
PidRequired	choice

Input fields[3]

Field	Type
Visitor IDRequired	text
Message TextRequired	text
Agent ID	text
Agent Email	email
Agent Name	text

1other input field

Output fields[3]

Field	Type
ID	text
Text	text
HTML	text
Agent ID	text
Created At	number

2other output fields

Input fields[3]

Field	Type
Sender	object
Name	text
Email	email
ID	number
ToRequired	array
Email	email
Name	text
BCC	array
Email	email
Name	text
CC	array
Email	email
Name	text
HTML Content	text

11other input fields

Output fields[3]

Field	Type
Message ID	text

Input fields[3]

Field	Type
Email CampaignRequired	choice

Input fields[3]

Field	Type
Email CampaignRequired	choice
Language	choice
EmailRequired	object
To	array

Input fields[3]

Field	Type
Email CampaignRequired	choice
Email To	array
Email	email

Input fields[3]

Field	Type
Agent ID	text
Agent Email	email
Agent Name	text
Received From	text
Visitor IDRequired	text

1other input field

Output fields[3]

Field	Type
ID	text
Text	text
Created At	number

Input fields[3]

Field	Type
SenderRequired	text
RecipientRequired	text
Content	text
Template	choice
Type	choice

5other input fields

Output fields[3]

Field	Type
Message ID	number
Reference	text
SMS Count	number
Used Credits	number
Remaining Credits	number

Input fields[3]

Field	Type
SenderRequired	text
RecipientRequired	text
Content	text
Template	choice
Type	choice

5other input fields

Output fields[3]

Field	Type
Message ID	number

Input fields[3]

Field	Type
SMS CampaignRequired	choice

Input fields[3]

Field	Type
SMS CampaignRequired	choice
Language	choice
EmailRequired	object
To	array

Input fields[3]

Field	Type
SMS CampaignRequired	choice
Phone Number	text

Input fields[3]

Field	Type
TemplateRequired	choice
Email To	array
Email	email

Input fields[3]

Field	Type
Sender NumberRequired	text
Recipient NumbersRequired	array
Phone Number	text
Template IDRequired	number
Params	object

Output fields[3]

Field	Type
Message ID	text

Input fields[3]

Field	Type
CurrencyRequired	text

Output fields[3]

Field	Type
Code	text

Input fields[3]

Field	Type
Email CampaignRequired	choice
StatusRequired	choice

Input fields[3]

Field	Type
Product IDRequired	choice
Alert TypeRequired	choice
Enabled	boolean

Input fields[3]

Field	Type
SMS CampaignRequired	choice
StatusRequired	choice

Input fields[3]

Field	Type
Template IDRequired	number

Input fields[3]

Field	Type
PidRequired	choice
Contact ID	choice
Loyalty Subscription ID	text
Member Contact IdsRequired	array
Member Contact Ids	number

Output fields[3]

Field	Type
Organization ID	number
Owner Contact ID	number
Member Contact Ids	array
Member Contact ID	number
Created At	date
Updated At	date

Input fields[3]

Field	Type
PidRequired	choice
Contact IDRequired	choice
Loyalty Subscription ID	text
Creation Date	text
Meta	object

Output fields[3]

Field	Type
Organization ID	number
Loyalty Program ID	text
Version ID	number
Contact ID	number
Loyalty Subscription ID	text

3other output fields

Input fields[3]

Field	Type
Sub-AccountRequired	choice
Automation	boolean
Conversations	boolean
Sales CRM	boolean
Email Campaigns	boolean

9other input fields

Input fields[3]

Field	Type
DomainRequired	text

Input fields[3]

Field	Type
GroupRequired	choice
Sub-Account IDsRequired	array
Sub-Account	choice

Input fields[3]

Field	Type
Attribute CategoryRequired	choice
Attribute NameRequired	text
Value	text
Enumeration	array
Value	number
Label	text
Multi Category Options	array
Option	text

Input fields[3]

Field	Type
PidRequired	choice
BdidRequired	choice
Balance Availability Duration Modifier	text
Balance Availability Duration Unit	text
Balance Availability Duration Value	number

13other input fields

Output fields[3]

Field	Type
ID	text
Name	text
Description	text
Image Ref	url
Meta	object

15other output fields

Input fields[3]

Field	Type
PidRequired	choice
BdidRequired	choice
BlidRequired	text
Constraint TypeRequired	text
Duration UnitRequired	text

4other input fields

Output fields[3]

Field	Type
ID	text
Balance Definition ID	text
Transaction Type	text
Constraint Type	text
Duration Value	number

5other output fields

Input fields[3]

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

1other input field

Output fields[3]

Field	Type
Attributes	object
ID	text
Linked Contacts Ids	array
Linked Contacts Ids	number
Linked Deals Ids	array
Linked Deals Ids	text

Input fields[3]

Field	Type
IdentifierRequired	text
Identifier Type	choice
Attributes	object
Email Blacklisted	boolean
SMS Blacklisted	boolean

5other input fields

Input fields[3]

Field	Type
Message IDRequired	text
Text	text

Output fields[3]

Field	Type
ID	text
Text	text

Input fields[3]

Field	Type
Group IDRequired	text

Output fields[3]

Field	Type
Group ID	text
Visitor ID	text

Input fields[3]

Field	Type
User EmailRequired	email
All Features AccessRequired	boolean
Privileges	array
Feature	choice
Permissions	array

Input fields[3]

Field	Type
Coupon CollectionRequired	choice
Default Coupon	text
Expiration Date	date
Remaining Coupons Alert	number
Remaining Days Alert	number

Output fields[3]

Field	Type
ID	text
Name	text
Default Coupon	text

Input fields[3]

Field	Type
Attribute IDRequired	text
Label	text

Input fields[3]

Field	Type
DealRequired	choice
Attributes	object
Linked Contact IDs	array
Contact	choice
Linked Company IDs	array
Company	choice
Unlinked Contact IDs	array
Contact	choice

1other input field

Input fields[3]

Field	Type
Email CampaignRequired	choice
Name	text
Subject	text
Sender	object
Name	text
Email	email
ID	number
HTML Content	text

22other input fields

Input fields[3]

Field	Type
External FeedRequired	choice
Name	text
URL	url
Auth Type	choice
Username	text

5other input fields

Input fields[3]

Field	Type
FolderRequired	choice
NameRequired	text

Input fields[3]

Field	Type
GroupRequired	choice
Group Name	text
Sub-Account IDs	array
Sub-Account	choice

Input fields[3]

Field	Type
ListRequired	choice
Name	text
Folder	choice

Input fields[3]

Field	Type
Loyalty ProgramRequired	choice
NameRequired	text
Description	text
Meta	object

Output fields[3]

Field	Type
ID	text
Name	text

Input fields[3]

Field	Type
Note IDRequired	choice
Text	text
Contact IDs	array
Contact	choice
Company IDs	array
Company	choice
Deal IDs	array
Deal	choice

Input fields[3]

Field	Type
User EmailRequired	email
All Features AccessRequired	boolean
PrivilegesRequired	array
Feature	choice
Permissions	array

Output fields[3]

Field	Type
Status	text
Invoice ID	text
Credit Notes	array
Credit Note	text

Input fields[3]

Field	Type
User EmailRequired	email
All Features AccessRequired	boolean
PrivilegesRequired	array
Feature	choice
Permissions	array

Output fields[3]

Field	Type
Credit Notes	array
Credit Notes	text
Invoice ID	text
Status	text

Input fields[3]

Field	Type
Message IDRequired	text
Message Text	text

Output fields[3]

Field	Type
ID	text
Text	text

Input fields[3]

Field	Type
SenderRequired	choice
Name	text
Email	email
IPs	array
IP	text
Domain	text
Weight	number

Input fields[3]

Field	Type
SMS CampaignRequired	choice
Name	text
Sender	text
Content	text
Recipients	object
List IDs	array
Exclusion List IDs	array

4other input fields

Input fields[3]

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

Input fields[3]

Field	Type
Task IDRequired	choice
Name	text
Task Type	choice
Due Date	date
Duration (ms)	number

7other input fields

Input fields[3]

Field	Type
TemplateRequired	choice
Template Name	text
Subject	text
Sender	object
Name	text
Email	email
ID	number
HTML Content	text

6other input fields

Input fields[3]

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

1other input field

Output fields[3]

Field	Type
ID	text
Name	text

Input fields[3]

Field	Type
Loyalty ProgramRequired	choice
Tier Group IDRequired	text
NameRequired	text
Upgrade StrategyRequired	choice
Downgrade StrategyRequired	choice

2other input fields

Output fields[3]

Field	Type
ID	text
Name	text

Input fields[3]

Field	Type
WebhookRequired	choice
URL	url
Description	text
Events	array
Event	choice
Domain	text

3other input fields

Input fields[3]

Field	Type
Campaign IDRequired	choice
Campaign Name	text
Campaign Status	text
Recipients	object
Reschedule For	text

Input fields[3]

Field	Type
FileRequired	text
FilenameRequired	text
Contact ID	number
Deal ID	text
Company ID	text

Output fields[3]

Field	Type
ID	text
Name	text
Size	number

Input fields[3]

Field	Type
Image FileRequired	text
FilenameRequired	text

Output fields[3]

Field	Type
Image URL	url

Input fields[3]

Field	Type
Object TypeRequired	text
RecordsRequired	array
Identifiers	object
Attributes	object
Associations	array

Output fields[3]

Field	Type
Message	text
Process ID	number

Input fields[3]

Field	Type
PidRequired	choice
Attributed Reward ID	text
Code	text
Contact ID	choice
Loyalty Subscription ID	text

2other input fields

Output fields[3]

Field	Type
Authorize	boolean

Input fields[3]

Field	Type
SenderRequired	choice
OTPRequired	number

Templates

Look for Brevo templates in the WEXTL template library.

Browse templates →

Explore alternative apps

More apps in Communication category →

References

WEXTL® Brevo Source Code connector implementation.
Our users use cases and automations.
Official API Documentation for Brevo.
WEXTL® visual workflow builder data.

Last updated: Jul 22, 2026 23:18

How we write our apps documentation

How we compile these docs — sources, AI's role, and how we verify.