Brevo icon

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 →

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]

  • API KeypasswordRequired

    Your API key. Find it in your account under SMTP & API Keys.

    [1]
  1. Log in to your WEXTL account, add the Brevo node module to your workflow, and click Create new credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your Brevo account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. 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]

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 →

Watch Activity LogsTrigger
Output fields[3]
FieldType
Actiontext
Datedate
User Agenttext
User Emailemail
User IPtext
Watch Email CampaignsTrigger
Output fields[3]
FieldType
IDnumber
Nametext
Subjecttext
Statustext
Typetext
2other output fields
Watch Email EventsTrigger
Output fields[3]
FieldType
Datedate
Emailemail
Eventtext
Fromemail
Message IDtext
2other output fields
Watch Inbound EmailsTrigger
Output fields[3]
FieldType
UUIDtext
Senderemail
Recipientemail
Datedate
Watch New CategoriesTrigger
Output fields[3]
FieldType
IDtext
Nametext
URLurl
Created Atdate
Modified Atdate
Watch New ContactsTrigger
Output fields[3]
FieldType
IDnumber
Emailemail
Email Blacklistedboolean
SMS Blacklistedboolean
Created Atdate
3other output fields
Watch New Coupon CollectionsTrigger
Output fields[3]
FieldType
Created Atdate
Default Coupontext
Expiration Datedate
IDtext
Nametext
4other output fields
Watch New CRM FilesTrigger
Output fields[3]
FieldType
IDtext
Nametext
Author IDtext
Contact IDnumber
Deal IDtext
3other output fields
Watch New Email LogsTrigger
Output fields[3]
FieldType
Datedate
Emailemail
Fromemail
Message IDtext
Subjecttext
3other output fields
Watch New FeedsTrigger
Output fields[3]
FieldType
IDtext
Nametext
URLurl
Auth Typetext
Created Atdate
1other output field
Watch New Folder ListsTrigger
Output fields[3]
FieldType
IDnumber
Nametext
Total Blacklistednumber
Total Subscribersnumber
Unique Subscribersnumber
Watch New FoldersTrigger
Output fields[3]
FieldType
IDnumber
Nametext
Total Blacklistednumber
Total Subscribersnumber
Unique Subscribersnumber
Watch New List ContactsTrigger
Output fields[3]
FieldType
Contactsarray
Attributesobject
Created Atdate
Emailemail
Email Blacklistedboolean
IDnumber
List Idsarray
List Unsubscribedarray
Modified Atdate
SMS Blacklistedboolean
Whatsapp Blacklistedboolean
Countnumber
Watch New ListsTrigger
Output fields[3]
FieldType
Countnumber
Listsarray
IDnumber
Nametext
Total Blacklistednumber
Total Subscribersnumber
Unique Subscribersnumber
Folder IDnumber
Watch New NotesTrigger
Output fields[3]
FieldType
IDtext
Texttext
Contact Idsarray
Contact Idsnumber
Company Idsarray
Company Idstext
Deal Idsarray
Deal Idstext
3other output fields
Watch New ProcessesTrigger
Output fields[3]
FieldType
IDnumber
Nametext
Statustext
Infoobject
Importobject
Export URLurl
Watch New ProductsTrigger
Output fields[3]
FieldType
Brandtext
Categoriesarray
Categoriestext
Created Atdate
Descriptiontext
IDtext
14other output fields
Watch New SegmentsTrigger
Output fields[3]
FieldType
Category Nametext
IDnumber
Segment Nametext
Updated Atdate
Watch New SendersTrigger
Output fields[3]
FieldType
Activeboolean
Emailtext
IDnumber
Ipsarray
Nametext
Watch New SMS EventsTrigger
Output fields[3]
FieldType
Datedate
Eventtext
Message IDtext
Phone Numbertext
Reasontext
2other output fields
Watch New TasksTrigger
Output fields[3]
FieldType
IDtext
Task Type IDtext
Nametext
Companies Idsarray
Companies Idstext
Deals Idsarray
Deals Idstext
7other output fields
Get AccountAction
Output fields[3]
FieldType
Organization IDtext
User IDnumber
Enterpriseboolean
Company Nametext
Emailemail
6other output fields
Get Attribution MetricsAction
Input fields[3]
FieldType
Period Fromdate
Period Todate
Email Campaign IDsarray
Campaignchoice
SMS Campaign IDsarray
Campaignchoice
Output fields[3]
FieldType
Resultsarray
IDtext
Conversion Sourcetext
Orders Countnumber
Revenuenumber
Average Basketnumber
Totalsobject
Orders Countnumber
Revenuenumber
Average Basketnumber
Get Attribution ProductsAction
Input fields[3]
FieldType
Conversion SourceRequired
choice
Conversion Source IDRequired
text
Output fields[3]
FieldType
Productsarray
IDtext
Nametext
Image URLurl
Pricenumber
Orders Countnumber
Get Balance DefinitionAction
Input fields[3]
FieldType
PidRequired
choice
BdidRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Image Refurl
Metaobject
15other output fields
Get Balance Definition ListSearch
Input fields[3]
FieldType
PidRequired
choice
Limitnumber
Output fields[3]
FieldType
Itemsarray
IDtext
Nametext
Descriptiontext
Image Refurl
Metaobject
Unittext
Min Amountnumber
Max Amountnumber
Max Credit Amount Limitnumber
Max Debit Amount Limitnumber
Get Balance LimitAction
Input fields[3]
FieldType
PidRequired
choice
BdidRequired
choice
BlidRequired
text
Output fields[3]
FieldType
IDtext
Balance Definition IDtext
Transaction Typetext
Constraint Typetext
Duration Valuenumber
5other output fields
Get CategoryAction
Input fields[3]
FieldType
Category IDRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
URLurl
Created Atdate
Modified Atdate
Get Code CountAction
Input fields[3]
FieldType
PidRequired
choice
CpidRequired
text
Output fields[3]
FieldType
Countnumber
Get CompanyAction
Input fields[3]
FieldType
CompanyRequired
choice
Output fields[3]
FieldType
IDtext
Attributesobject
Linked Contacts IDsarray
IDnumber
Linked Deals IDsarray
IDtext
Get ContactAction
Input fields[3]
FieldType
IdentifierRequired
text
Output fields[3]
FieldType
IDnumber
Emailemail
Email Blacklistedboolean
SMS Blacklistedboolean
Created Atdate
3other output fields
Get Contact BalancesSearch
Input fields[3]
FieldType
PidRequired
choice
Limitnumber
Output fields[3]
FieldType
Balance Definition IDtext
Balancesarray
Contact IDnumber
Loyalty Subscription IDtext
Updated Atdate
Valuenumber
Countnumber
Loyalty Program IDtext
Get Contact StatsAction
Input fields[3]
FieldType
IdentifierRequired
text
Start Datetext
End Datetext
Output fields[3]
FieldType
Messages Sentarray
Hard Bouncesarray
Soft Bouncesarray
Complaintsarray
Deliveredarray
4other output fields
Get Conversation MessageAction
Input fields[3]
FieldType
Message IDRequired
text
Output fields[3]
FieldType
IDtext
Texttext
HTMLtext
Agent IDtext
Created Atnumber
1other output field
Get Corporate User PermsAction
Input fields[3]
FieldType
User EmailRequired
email
Output fields[3]
FieldType
Emailemail
All Features Accessboolean
Privilegesarray
Featuretext
Permissionsarray
Get Coupon CollectionAction
Input fields[3]
FieldType
Coupon CollectionRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Default Coupontext
Remaining Couponsnumber
Total Couponsnumber
1other output field
Get CRM File LinkAction
Get CRM File MetaAction
Input fields[3]
FieldType
File IDRequired
text
Output fields[3]
FieldType
IDtext
Nametext
Sizenumber
Typetext
Created Atdate
Get CRM Pipeline by IDAction
Input fields[3]
FieldType
Pipeline IDRequired
text
Output fields[3]
FieldType
Pipeline IDtext
Pipeline Nametext
Stagesarray
Stage IDtext
Stage Nametext
Get CRM Pipeline DetailsAction
Output fields[3]
FieldType
Pipeline IDtext
Pipeline Nametext
Stagesarray
Stage IDtext
Stage Nametext
Get CRM TasktypesSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
IDtext
Titletext
Get DealAction
Input fields[3]
FieldType
DealRequired
choice
Output fields[3]
FieldType
IDtext
Attributesobject
Linked Contacts IDsarray
Contact IDnumber
Linked Companies IDsarray
Company IDtext
Get Display CurrencyAction
Output fields[3]
FieldType
Currencytext
Get DomainAction
Input fields[3]
FieldType
Domain NameRequired
text
Output fields[3]
FieldType
Domaintext
Verifiedboolean
Authenticatedboolean
DNS Recordsobject
Brevo Codeobject
DKIM Recordobject
DMARC Recordobject
Get Email CampaignAction
Input fields[3]
FieldType
Email CampaignRequired
choice
Statisticschoice
Output fields[3]
FieldType
IDnumber
Nametext
Subjecttext
Typetext
Statustext
3other output fields
Get Email Campaign AB ResultAction
Input fields[3]
FieldType
Email CampaignRequired
choice
Output fields[3]
FieldType
Winning Versiontext
Winning Criteriatext
Winning Subject Linetext
Open Rateobject
Click Rateobject
1other output field
Get Email Campaign Shared URLAction
Input fields[3]
FieldType
Email CampaignRequired
choice
Output fields[3]
FieldType
Shared URLurl
Get Email ContentAction
Input fields[3]
FieldType
UUIDRequired
choice
Output fields[3]
FieldType
Datetext
Emailtext
Eventsarray
Subjecttext
Bodytext
1other output field
Get Email ReportAction
Input fields[3]
FieldType
Start Datedate
End Datedate
Daysnumber
Tagtext
Output fields[3]
FieldType
Blockednumber
Clicksnumber
Deliverednumber
Hard bouncesnumber
Invalidnumber
8other output fields
Get Email Stats ReportSearch
Input fields[3]
FieldType
Start Datetext
End Datetext
Daysnumber
Tagtext
Sortchoice
1other input field
Output fields[3]
FieldType
Datedate
Requestsnumber
Deliverednumber
Hard Bouncesnumber
Soft Bouncesnumber
8other output fields
Get FeedAction
Input fields[3]
FieldType
External FeedRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
URLurl
Auth Typetext
Max Retriesnumber
3other output fields
Get FolderAction
Input fields[3]
FieldType
FolderRequired
choice
Output fields[3]
FieldType
IDnumber
Nametext
Total Blacklistednumber
Total Subscribersnumber
Get GroupAction
Input fields[3]
FieldType
GroupRequired
choice
Output fields[3]
FieldType
Groupobject
IDtext
Group Nametext
Created Attext
Sub-Accountsarray
IDnumber
Company Nametext
Created Attext
Usersarray
Emailemail
First Nametext
Last Nametext
Get Inbound EmailAction
Input fields[3]
FieldType
UUIDRequired
text
Output fields[3]
FieldType
Received Atdate
Delivered Atdate
Senderemail
Recipientemail
Subjecttext
3other output fields
Get ListAction
Input fields[3]
FieldType
ListRequired
choice
Output fields[3]
FieldType
IDnumber
Nametext
Folder IDnumber
Total Blacklistednumber
Total Subscribersnumber
Get Loyalty Account InfoAction
Input fields[3]
FieldType
Loyalty ProgramRequired
choice
Contact IDtext
Loyalty Subscription IDtext
Include Internalboolean
Paramstext
Output fields[3]
FieldType
Balanceobject
Tiersarray
Rewardsarray
Get Loyalty BalanceSearch
Input fields[3]
FieldType
Loyalty ProgramRequired
choice
Contact IDnumber
Loyalty Subscription IDtext
Balance Definition IDtext
Sort Fieldtext
2other input fields
Output fields[3]
FieldType
IDtext
Amountnumber
Contact IDnumber
Loyalty Program IDtext
Balance Definition IDtext
2other output fields
Get Loyalty Offer Programs RewardsSearch
Input fields[3]
FieldType
PidRequired
choice
RidRequired
choice
Limitnumber
Output fields[3]
FieldType
Attribution Per Consumernumber
Balance Definition IDtext
Codetext
Code Countnumber
Code Generator IDtext
35other output fields
Get Loyalty Offer Programs VouchersSearch
Input fields[3]
FieldType
PidRequired
choice
Limitnumber
Output fields[3]
FieldType
Contact IDnumber
Contact Rewardsarray
Codetext
Consumed Atdate
Created Atdate
Expiration Datetext
IDtext
Metaobject
Reward IDtext
Unittext
Updated Atdate
Valuenumber
Countnumber
Loyalty Program IDtext
Loyalty Subscription IDtext
Get Loyalty ProgramAction
Input fields[3]
FieldType
Loyalty ProgramRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Document IDtext
Metaobject
Get Master AccountAction
Output fields[3]
FieldType
IDnumber
Company Nametext
Emailemail
Currency Codetext
Timezonetext
Get Master Account SSOAction
Input fields[3]
FieldType
User EmailRequired
email
Output fields[3]
FieldType
Tokentext
Get NoteAction
Input fields[3]
FieldType
Note IDRequired
choice
Output fields[3]
FieldType
IDtext
Texttext
Contact IDsarray
Contact IDnumber
Company IDsarray
Company IDtext
Deal IDsarray
Deal IDtext
2other output fields
Get Org User PermsAction
Input fields[3]
FieldType
User EmailRequired
email
Output fields[3]
FieldType
Emailemail
Statustext
Privilegesarray
Featuretext
Permissionsarray
Get Payment RequestAction
Input fields[3]
FieldType
Payment Request IDRequired
text
Output fields[3]
FieldType
IDtext
Referencetext
Statustext
Payment URLurl
Amountnumber
2other output fields
Get ProcessAction
Input fields[3]
FieldType
ProcessRequired
choice
Output fields[3]
FieldType
IDnumber
Nametext
Statustext
Export URLurl
Infoobject
Get ProductAction
Input fields[3]
FieldType
Product IDRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Pricenumber
SKUtext
URLurl
4other output fields
Get Pushed MessageAction
Input fields[3]
FieldType
Message IDRequired
text
Output fields[3]
FieldType
IDtext
Texttext
Created Atnumber
Get SMS Aggregated ReportAction
Input fields[3]
FieldType
Start Datetext
End Datetext
Daysnumber
Tagtext
Output fields[3]
FieldType
Rangetext
Requestsnumber
Deliverednumber
Hard Bouncesnumber
Soft Bouncesnumber
5other output fields
Get SMS CampaignAction
Input fields[3]
FieldType
SMS CampaignRequired
choice
Output fields[3]
FieldType
IDnumber
Nametext
Statustext
Contenttext
Sendertext
3other output fields
Get SMS Stats ReportSearch
Input fields[3]
FieldType
Start Datetext
End Datetext
Daysnumber
Tagtext
Sortchoice
1other input field
Output fields[3]
FieldType
Datedate
Requestsnumber
Deliverednumber
Hard Bouncesnumber
Soft Bouncesnumber
5other output fields
Get Source MetricsAction
Input fields[3]
FieldType
Conversion SourceRequired
choice
Conversion Source IDRequired
text
Output fields[3]
FieldType
IDtext
Conversion Sourcetext
Orders Countnumber
Revenuenumber
Average Basketnumber
1other output field
Get Sub-AccountAction
Input fields[3]
FieldType
Sub-AccountRequired
choice
Output fields[3]
FieldType
Company Nametext
Emailemail
Nametext
Groupsarray
IDtext
Nametext
Plan Infoobject
Plan Typetext
Get Subscription BalancesSearch
Input fields[3]
FieldType
PidRequired
choice
CidRequired
choice
Limitnumber
Output fields[3]
FieldType
Loyalty Program IDtext
Contact IDnumber
Balancearray
Balance Definition IDtext
Valuenumber
Get TaskAction
Input fields[3]
FieldType
Task IDRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Task Type IDtext
Due Datedate
Doneboolean
5other output fields
Get TemplateAction
Input fields[3]
FieldType
TemplateRequired
choice
Output fields[3]
FieldType
IDnumber
Nametext
Subjecttext
Is Activeboolean
DOI Templateboolean
8other output fields
Get Tier GroupAction
Input fields[3]
FieldType
Loyalty ProgramRequired
choice
Tier GroupRequired
choice
Versionchoice
Output fields[3]
FieldType
IDtext
Nametext
Upgrade Strategytext
Downgrade Strategytext
Tier Orderarray
Tier IDtext
Get WA CampaignAction
Input fields[3]
FieldType
WhatsApp CampaignRequired
choice
Output fields[3]
FieldType
IDnumber
Campaign Nametext
Campaign Statustext
Scheduled Atdate
Created Atdate
1other output field
Get WebhookAction
Input fields[3]
FieldType
WebhookRequired
choice
Output fields[3]
FieldType
IDnumber
URLurl
Descriptiontext
Eventsarray
Eventtext
Typetext
4other output fields
Get Whatsapp ConfigAction
Output fields[3]
FieldType
Phone Numbertext
WhatsApp Account IDtext
Created Atdate
List Activity LogsSearch
Input fields[3]
FieldType
Start Datetext
End Datetext
User Emailemail
Limitnumber
Output fields[3]
FieldType
Actiontext
Datedate
User Agenttext
User Emailemail
User IPtext
List Admin UsersSearch
Input fields[3]
FieldType
User Typechoice
Limitnumber
Output fields[3]
FieldType
Emailemail
Is Ownerboolean
Statustext
Feature Accessobject
List AttributesSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Categorytext
Nametext
Typetext
Enumerationarray
Valuenumber
Labeltext
Multi Category Optionsarray
Optiontext
1other output field
List Blocked ContactsSearch
Input fields[3]
FieldType
Start Datedate
End Datedate
Sendersarray
Sender Emailemail
Sortchoice
Limitnumber
Output fields[3]
FieldType
Blocked atdate
Emailemail
Reasonobject
Codetext
Messagetext
Sender emailemail
List Blocked DomainsSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Domaintext
Created Atdate
List CategoriesSearch
Input fields[3]
FieldType
Category IDsarray
IDtext
Nametext
Sortchoice
Created Sincedate
Modified Sincedate
2other input fields
Output fields[3]
FieldType
IDtext
Nametext
URLurl
Created Atdate
Modified Atdate
List CompaniesSearch
Input fields[3]
FieldType
Name Filtertext
Linked Contact IDstext
Linked Deal IDstext
Sortchoice
Sort Bytext
3other input fields
Output fields[3]
FieldType
IDtext
Attributesobject
Linked Contacts IDsarray
IDnumber
Linked Deals IDsarray
IDtext
List Company AttributesSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
IDtext
Nametext
Labeltext
Typetext
List ContactsSearch
Input fields[3]
FieldType
Modified Sincedate
Created Sincedate
Sortchoice
Segment IDchoice
List IDsarray
Listchoice
2other input fields
Output fields[3]
FieldType
IDnumber
Emailemail
Email Blacklistedboolean
SMS Blacklistedboolean
Created Atdate
3other output fields
List Corporate IpsSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
IPtext
Domaintext
Transactionalboolean
List Coupon CollectionsSearch
Input fields[3]
FieldType
Sortchoice
Sort Bytext
Limitnumber
Output fields[3]
FieldType
IDtext
Nametext
Default Coupontext
Remaining Couponsnumber
Total Couponsnumber
1other output field
List CRM FilesSearch
Input fields[3]
FieldType
Entity Typechoice
Entity IDstext
Date From (Unix ms)number
Date To (Unix ms)number
Sortchoice
1other input field
Output fields[3]
FieldType
IDtext
Nametext
Sizenumber
Typetext
Created Atdate
List Deal AttributesSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
IDtext
Nametext
Labeltext
Typetext
List DealsSearch
Input fields[3]
FieldType
Deal Name Filtertext
Linked Companies IDstext
Linked Contacts IDstext
Sortchoice
Sort Bytext
3other input fields
Output fields[3]
FieldType
IDtext
Attributesobject
Deal Nametext
Amountnumber
Deal Stagetext
Close Datetext
Linked Contacts IDsarray
Contact IDnumber
Linked Companies IDsarray
Company IDtext
List Dedicated IpsSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
IDnumber
IPtext
Domaintext
Activeboolean
List DomainsSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
IDtext
Domain Nametext
Authenticatedboolean
Verifiedboolean
IPtext
2other output fields
List Email CampaignsSearch
Input fields[3]
FieldType
Typechoice
Statuschoice
Statisticschoice
Start Datetext
End Datetext
4other input fields
Output fields[3]
FieldType
IDnumber
Nametext
Subjecttext
Typetext
Statustext
4other output fields
List Email EventsSearch
Input fields[3]
FieldType
Start Datetext
End Datetext
Daysnumber
Emailemail
Event Typechoice
5other input fields
Output fields[3]
FieldType
Datedate
Emailemail
Eventtext
Message IDtext
Fromtext
3other output fields
List Email LogsSearch
Input fields[3]
FieldType
Emailemail
Templatechoice
Message IDtext
Start Datetext
End Datetext
2other input fields
Output fields[3]
FieldType
Datedate
Emailemail
Message IDtext
Subjecttext
UUIDtext
1other output field
List EventsSearch
Input fields[3]
FieldType
Contact IDnumber
Event Nametext
Event Filter IDtext
Object Typetext
Start Datetext
2other input fields
Output fields[3]
FieldType
Contact IDnumber
Event Datedate
Event Nametext
Event Filter IDtext
Object Typetext
2other output fields
List FeedsSearch
Input fields[3]
FieldType
Searchtext
Start Datetext
End Datetext
Sortchoice
Auth Typechoice
1other input field
Output fields[3]
FieldType
IDtext
Nametext
URLurl
Auth Typetext
Usernametext
6other output fields
List Folder ListsSearch
Input fields[3]
FieldType
FolderRequired
choice
Sortchoice
Limitnumber
Output fields[3]
FieldType
IDnumber
Nametext
Folder IDnumber
Total Blacklistednumber
Total Subscribersnumber
1other output field
List FoldersSearch
Input fields[3]
FieldType
Sortchoice
Limitnumber
Output fields[3]
FieldType
IDnumber
Nametext
Total Blacklistednumber
Total Subscribersnumber
List GroupsSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
IDtext
Group Nametext
List Inbound EmailsSearch
Input fields[3]
FieldType
Senderemail
Start Datetext
End Datetext
Sortchoice
Limitnumber
Output fields[3]
FieldType
UUIDtext
Senderemail
Recipientemail
Datedate
List List ContactsSearch
Input fields[3]
FieldType
ListRequired
choice
Modified Sincedate
Created Sincedate
Sortchoice
Limitnumber
Output fields[3]
FieldType
IDnumber
Emailemail
Email Blacklistedboolean
SMS Blacklistedboolean
Created Atdate
2other output fields
List ListsSearch
Input fields[3]
FieldType
Sortchoice
Limitnumber
Output fields[3]
FieldType
IDnumber
Nametext
Folder IDnumber
Total Blacklistednumber
Total Subscribersnumber
2other output fields
List Loyalty ProgramsSearch
Input fields[3]
FieldType
Sort Fieldtext
Sort Orderchoice
Limitnumber
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Document IDtext
Metaobject
List Loyalty RewardsSearch
Input fields[3]
FieldType
Loyalty ProgramRequired
choice
Statetext
Versionchoice
Limitnumber
Output fields[3]
FieldType
IDtext
Nametext
Loyalty Program IDtext
Statetext
Start Datedate
4other output fields
List Loyalty TransactionsSearch
Input fields[3]
FieldType
Loyalty ProgramRequired
choice
Contact IDRequired
number
Balance Definition IDRequired
text
Statuschoice
Transaction Typechoice
4other input fields
Output fields[3]
FieldType
IDtext
Amountnumber
Transaction Typetext
Statustext
Created Atdate
3other output fields
List NotesSearch
Input fields[3]
FieldType
Entity Typechoice
Entity IDstext
Date From (Unix ms)number
Date To (Unix ms)number
Sortchoice
1other input field
Output fields[3]
FieldType
IDtext
Texttext
Contact IDsarray
Contact IDnumber
Company IDsarray
Company IDtext
Deal IDsarray
Deal IDtext
3other output fields
List Object RecordsSearch
Input fields[3]
FieldType
Object TypeRequired
text
Sortchoice
Include Associationschoice
Limitnumber
Output fields[3]
FieldType
Identifiersobject
IDnumber
External IDtext
Attributesobject
Associationsarray
Created Atdate
Updated Atdate
List OrdersSearch
Input fields[3]
FieldType
Modified Sincedate
Created Sincedate
Sortchoice
Limitnumber
Output fields[3]
FieldType
IDtext
Statustext
Amountnumber
Contact Emailemail
Created Atdate
1other output field
List Org UsersSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Emailemail
Is Ownerboolean
Statustext
Feature Accessobject
List PipelinesSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Pipeline IDtext
Pipeline Nametext
Stagesarray
Stage IDtext
Stage Nametext
List ProcessesSearch
Input fields[3]
FieldType
Sortchoice
Limitnumber
Output fields[3]
FieldType
IDnumber
Nametext
Statustext
Export URLurl
Infoobject
Importobject
List ProductsSearch
Input fields[3]
FieldType
Product IDsarray
IDtext
Nametext
Max Pricenumber
Min Pricenumber
Sortchoice
4other input fields
Output fields[3]
FieldType
IDtext
Nametext
Pricenumber
SKUtext
Image URLurl
4other output fields
List Scheduled EmailsSearch
Input fields[3]
FieldType
Batch ID or Message IDRequired
choice
Start Datedate
End Datedate
Sortchoice
Statuschoice
1other input field
Output fields[3]
FieldType
Scheduled Atdate
Created Atdate
Statustext
List SegmentsSearch
Input fields[3]
FieldType
Sortchoice
Limitnumber
Output fields[3]
FieldType
IDnumber
Segment Nametext
Created Atdate
Recipients Countnumber
List Sender IpsSearch
Input fields[3]
FieldType
SenderRequired
choice
Limitnumber
Output fields[3]
FieldType
IDnumber
IPtext
Domaintext
Weightnumber
List SendersSearch
Input fields[3]
FieldType
IPtext
Domaintext
Limitnumber
Output fields[3]
FieldType
IDnumber
Nametext
Emailemail
Activeboolean
IPsarray
IPtext
Domaintext
Weightnumber
List SMS CampaignsSearch
Input fields[3]
FieldType
Statuschoice
Start Datetext
End Datetext
Sortchoice
Limitnumber
Output fields[3]
FieldType
IDnumber
Nametext
Statustext
Contenttext
Sendertext
3other output fields
List SMS EventsSearch
Input fields[3]
FieldType
Start Datetext
End Datetext
Daysnumber
Phone Numbertext
Event Typechoice
3other input fields
Output fields[3]
FieldType
Phone Numbertext
Datedate
Message IDtext
Eventtext
Reasontext
2other output fields
List SMS TemplatesSearch
Input fields[3]
FieldType
Searchtext
Sortchoice
Limitnumber
Output fields[3]
FieldType
IDnumber
Nametext
Contenttext
Sendertext
Tagtext
2other output fields
List Sub-AccountsSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
IDnumber
Company Nametext
Emailemail
List TasksSearch
Input fields[3]
FieldType
Task Typechoice
Status Filterchoice
Date Filterchoice
Assign To Filtertext
Contacts Filtertext
7other input fields
Output fields[3]
FieldType
IDtext
Nametext
Task Type IDtext
Due Datedate
Doneboolean
8other output fields
List TemplatesSearch
Input fields[3]
FieldType
Active Templates Onlyboolean
Editor Typechoice
Sortchoice
Limitnumber
Output fields[3]
FieldType
Created atdate
HTML contenttext
IDnumber
Is activeboolean
Modified atdate
7other output fields
List Tier GroupsSearch
Input fields[3]
FieldType
Loyalty ProgramRequired
choice
Limitnumber
Output fields[3]
FieldType
IDtext
Nametext
Upgrade Strategytext
Downgrade Strategytext
Tier Orderarray
Tier IDtext
List TiersSearch
Input fields[3]
FieldType
Loyalty ProgramRequired
choice
Versionchoice
Limitnumber
Output fields[3]
FieldType
IDtext
Nametext
Access Conditionsarray
Balance Definition IDtext
Minimum Valuenumber
List WA CampaignsSearch
Input fields[3]
FieldType
Start Datetext
End Datetext
Sortchoice
Limitnumber
Output fields[3]
FieldType
IDnumber
Campaign Nametext
Campaign Statustext
Scheduled Atdate
Template IDnumber
6other output fields
List WebhooksSearch
Input fields[3]
FieldType
Typechoice
Sortchoice
Limitnumber
Output fields[3]
FieldType
IDnumber
URLurl
Descriptiontext
Eventsarray
Eventtext
Typetext
6other output fields
List Whatsapp Event StatsSearch
Input fields[3]
FieldType
Start Datetext
End Datetext
Sortchoice
Event Typechoice
Contact Numbertext
1other input field
Output fields[3]
FieldType
Datedate
Contact Numbertext
Eventtext
Message IDtext
Template IDnumber
List Whatsapp TemplatesSearch
Input fields[3]
FieldType
Start Datetext
End Datetext
Sortchoice
Limitnumber
Output fields[3]
FieldType
IDnumber
Nametext
Statustext
Languagetext
Categorytext
1other output field
Activate EcommerceAction

No fields documented.

Add Subscription to TierAction
Input fields[3]
FieldType
PidRequired
choice
CidRequired
choice
TidRequired
choice
Output fields[3]
FieldType
Contact IDnumber
Created Atdate
Group IDtext
IDtext
Loyalty Program IDtext
2other output fields
Add to ListAction
Input fields[3]
FieldType
ListRequired
choice
Emailsarray
Emailemail
Contact IDsarray
Contact IDnumber
Output fields[3]
FieldType
Contactsobject
Failuretext
Process IDnumber
Successtext
Totalnumber
Associate IP to Sub-AccountsAction
Input fields[3]
FieldType
IP AddressRequired
text
Sub-Account IDsRequired
array
Sub-Accountchoice
Attribute RewardAction
Input fields[3]
FieldType
Loyalty ProgramRequired
choice
Reward IDRequired
text
Contact IDnumber
Loyalty Subscription IDtext
Codetext
4other input fields
Output fields[3]
FieldType
IDtext
Codetext
Contact IDnumber
Reward IDtext
Valuenumber
2other output fields
Authenticate DomainAction
Input fields[3]
FieldType
Domain NameRequired
text
Output fields[3]
FieldType
Domain Nametext
Messagetext
Batch Create CategoriesAction
Input fields[3]
FieldType
CategoriesRequired
array
Category IDtext
Nametext
URLurl
Deleted Attext
Update Enabledboolean
Output fields[3]
FieldType
Created Countnumber
Updated Countnumber
Batch Create EventsAction
Input fields[3]
FieldType
EventsRequired
array
Event Nametext
Identifiersobject
Event Datetext
Event Propertiesobject
Contact Propertiesobject
Objectobject
Output fields[3]
FieldType
Messagetext
Countnumber
Batch Create OrdersAction
Input fields[3]
FieldType
OrdersRequired
array
Order IDtext
Statuschoice
Amountnumber
Emailemail
Created Atdate
Updated Atdate
Output fields[3]
FieldType
Batch IDnumber
Countnumber
Batch Create ProductsAction
Input fields[3]
FieldType
ProductsRequired
array
Product IDtext
Nametext
URLurl
Image URLurl
SKUtext
Pricenumber
Categoriesarray
Deleted Attext
Update Enabledboolean
Output fields[3]
FieldType
Created Countnumber
Updated Countnumber
Batch Update ContactsAction
Input fields[3]
FieldType
ContactsRequired
array
Emailemail
IDnumber
SMStext
External IDtext
Attributesobject
Email Blacklistedboolean
SMS Blacklistedboolean
Add to List IDsarray
Remove from List IDsarray
SMTP Blacklist Sendersarray
Block a DomainAction
Input fields[3]
FieldType
DomainRequired
text
Bulk Update Sub-Account PlansAction
Input fields[3]
FieldType
Sub-Account IDsRequired
array
Sub-Accountchoice
Creditsobject
Email Creditsnumber
SMS Creditsnumber
WhatsApp Creditsnumber
Push Creditsnumber
External Feedsnumber
Featuresobject
Landing Pagesnumber
Sales Usersnumber
Usersnumber
Cancel Loyalty TransactionAction
Input fields[3]
FieldType
Loyalty ProgramRequired
choice
Transaction IDRequired
text
Output fields[3]
FieldType
IDtext
Statustext
Amountnumber
Complete Loyalty TransactionAction
Input fields[3]
FieldType
Loyalty ProgramRequired
choice
Transaction IDRequired
text
Output fields[3]
FieldType
IDtext
Statustext
Amountnumber
Complete Redeem TransactionAction
Input fields[3]
FieldType
PidRequired
choice
TidRequired
text
Output fields[3]
FieldType
Cancelled Atdate
Completed Atdate
Contact IDnumber
Created Atdate
Debit Transaction IDtext
9other output fields
Create AttributeAction
Input fields[3]
FieldType
Attribute CategoryRequired
choice
Attribute NameRequired
text
Typechoice
Valuetext
Enumerationarray
Valuenumber
Labeltext
1other input field
Create Balance LimitAction
Input fields[3]
FieldType
PidRequired
choice
BdidRequired
choice
Constraint TypeRequired
text
Duration UnitRequired
text
Duration ValueRequired
number
3other input fields
Output fields[3]
FieldType
IDtext
Balance Definition IDtext
Transaction Typetext
Constraint Typetext
Duration Valuenumber
5other output fields
Create Balance OrderAction
Input fields[3]
FieldType
PidRequired
choice
AmountRequired
number
Balance Definition IDRequired
choice
Contact IDRequired
choice
Due AtRequired
text
3other input fields
Output fields[3]
FieldType
Amountnumber
Balance Definition IDtext
Contact IDnumber
Created Atdate
Due Atdate
7other output fields
Create ContactAction
Input fields[3]
FieldType
Emailemail
External IDtext
Attributesobject
Email Blacklistedboolean
SMS Blacklistedboolean
5other input fields
Output fields[3]
FieldType
IDnumber
Create Coupon CollectionAction
Input fields[3]
FieldType
NameRequired
text
Default CouponRequired
text
Expiration Datedate
Remaining Coupons Alertnumber
Remaining Days Alertnumber
Output fields[3]
FieldType
IDtext
Create CouponsAction
Input fields[3]
FieldType
Coupon CollectionRequired
choice
CouponsRequired
array
Coupon Codetext
Create CRM AttributesAction
Input fields[3]
FieldType
Attribute TypeRequired
text
Descriptiontext
LabelRequired
text
Object TypeRequired
text
Options Labelsarray
Options Labelstext
Output fields[3]
FieldType
IDtext
Create CRM CompanyAction
Input fields[3]
FieldType
Company NameRequired
text
Attributesobject
Linked Contact IDsarray
Contactchoice
Linked Deal IDsarray
Dealchoice
Output fields[3]
FieldType
IDtext
Create DealAction
Input fields[3]
FieldType
Deal NameRequired
text
Attributesobject
Linked Contact IDsarray
Contactchoice
Linked Company IDsarray
Companychoice
Output fields[3]
FieldType
IDtext
Create DOI ContactAction
Input fields[3]
FieldType
EmailRequired
email
DOI TemplateRequired
choice
Redirection URLRequired
url
Include List IDsRequired
array
Listchoice
Exclude List IDsarray
Listchoice
1other input field
Create DomainAction
Input fields[3]
FieldType
Domain NameRequired
text
Output fields[3]
FieldType
IDtext
Domain Nametext
Domain Providertext
Messagetext
DNS Recordsobject
Brevo Codeobject
DKIM Recordobject
DMARC Recordobject
Create Email CampaignAction
Input fields[3]
FieldType
NameRequired
text
Subjecttext
SenderRequired
object
Nametext
Emailemail
IDnumber
TypeRequired
choice
HTML Contenttext
31other input fields
Output fields[3]
FieldType
IDnumber
Create EventAction
Input fields[3]
FieldType
Event NameRequired
text
IdentifiersRequired
object
Contact IDnumber
Email IDemail
External IDtext
Phone IDtext
WhatsApp IDtext
Landline Number IDtext
Event Datedate
Event Propertiesobject
Contact Propertiesobject
1other input field
Create FeedAction
Input fields[3]
FieldType
NameRequired
text
URLRequired
url
Auth Typechoice
Usernametext
Passwordsecret
4other input fields
Output fields[3]
FieldType
IDtext
Create FolderAction
Input fields[3]
FieldType
NameRequired
text
Output fields[3]
FieldType
IDnumber
Create GroupAction
Input fields[3]
FieldType
Group NameRequired
text
Sub-Account IDsarray
Sub-Accountchoice
Output fields[3]
FieldType
IDtext
Create ListAction
Input fields[3]
FieldType
NameRequired
text
FolderRequired
choice
Output fields[3]
FieldType
IDnumber
Create Loyalty Balance Programs Balance DefinitionsAction
Input fields[3]
FieldType
PidRequired
choice
Balance Availability Duration Modifiertext
Balance Availability Duration Unittext
Balance Availability Duration Valuenumber
Balance Expiration Datetext
12other input fields
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Image Refurl
Metaobject
15other output fields
Create Loyalty Balance Programs Subscriptions BalancesAction
Input fields[3]
FieldType
PidRequired
choice
CidRequired
choice
Balance Definition IDRequired
choice
Output fields[3]
FieldType
IDtext
Amountnumber
Loyalty Program IDtext
Organization IDnumber
Contact IDnumber
4other output fields
Create Loyalty ProgramAction
Input fields[3]
FieldType
NameRequired
text
Descriptiontext
Document IDtext
Metaobject
Output fields[3]
FieldType
IDtext
Nametext
Create Loyalty RewardAction
Input fields[3]
FieldType
Loyalty ProgramRequired
choice
NameRequired
text
Public Nametext
Public Descriptiontext
Public Image URLurl
Output fields[3]
FieldType
IDtext
Nametext
Loyalty Program IDtext
Created Atdate
Create Loyalty TransactionAction
Input fields[3]
FieldType
Loyalty ProgramRequired
choice
AmountRequired
number
Balance Definition IDRequired
text
Transaction Typechoice
Contact IDnumber
6other input fields
Output fields[3]
FieldType
IDtext
Amountnumber
Transaction Typetext
Statustext
Contact IDnumber
2other output fields
Create NoteAction
Input fields[3]
FieldType
TextRequired
text
Contact IDsarray
Contactchoice
Company IDsarray
Companychoice
Deal IDsarray
Dealchoice
Output fields[3]
FieldType
IDtext
Create or Update CategoryAction
Input fields[3]
FieldType
Category IDRequired
choice
Nametext
URLurl
Update Enabledboolean
Deleted Attext
Output fields[3]
FieldType
IDtext
Create or Update OrderAction
Input fields[3]
FieldType
Order IDRequired
text
StatusRequired
choice
AmountRequired
number
Customer Emailemail
Billingobject
Addresstext
Citytext
Country Codetext
Zip Codetext
4other input fields
Create or Update ProductAction
Input fields[3]
FieldType
Product IDRequired
choice
NameRequired
text
URLurl
Image URLurl
SKUtext
5other input fields
Output fields[3]
FieldType
IDtext
Create Payment RequestAction
Input fields[3]
FieldType
ReferenceRequired
text
CartRequired
object
Itemsarray
Contact IDnumber
Contact Emailemail
Descriptiontext
2other input fields
Output fields[3]
FieldType
IDtext
Statustext
Payment URLurl
Create SenderAction
Input fields[3]
FieldType
NameRequired
text
EmailRequired
email
IPsarray
IPtext
Domaintext
Weightnumber
Output fields[3]
FieldType
IDnumber
DKIM Errorboolean
SPF Errorboolean
Create SMS CampaignAction
Input fields[3]
FieldType
NameRequired
text
SenderRequired
text
ContentRequired
text
Recipientsobject
List IDsarray
Exclusion List IDsarray
Scheduled Atdate
3other input fields
Output fields[3]
FieldType
IDnumber
Create Sub-AccountAction
Input fields[3]
FieldType
Company NameRequired
text
EmailRequired
email
Languagechoice
Timezonetext
Group IDsarray
Groupchoice
Output fields[3]
FieldType
IDnumber
Create Sub-Account API KeyAction
Input fields[3]
FieldType
Sub-AccountRequired
choice
Key NameRequired
text
Output fields[3]
FieldType
API Keytext
Statustext
Create TaskAction
Input fields[3]
FieldType
NameRequired
text
Task TypeRequired
choice
Due DateRequired
date
Duration (ms)number
Assign Totext
6other input fields
Output fields[3]
FieldType
IDtext
Create TemplateAction
Input fields[3]
FieldType
Template NameRequired
text
SubjectRequired
text
SenderRequired
object
Nametext
Emailemail
IDnumber
HTML Contenttext
HTML URLurl
5other input fields
Output fields[3]
FieldType
IDnumber
Create TierAction
Input fields[3]
FieldType
Loyalty ProgramRequired
choice
Tier Group IDRequired
text
Nametext
Access Conditionsarray
Balance Definition IDtext
Minimum Valuenumber
Metaobject
Output fields[3]
FieldType
IDtext
Nametext
Create Tier GroupAction
Input fields[3]
FieldType
Loyalty ProgramRequired
choice
NameRequired
text
Upgrade Strategychoice
Downgrade Strategychoice
Tier Orderarray
Tier IDtext
3other input fields
Output fields[3]
FieldType
IDtext
Nametext
Create WebhookAction
Input fields[3]
FieldType
URLRequired
url
Descriptiontext
EventsRequired
array
Eventchoice
TypeRequired
choice
Domaintext
3other input fields
Output fields[3]
FieldType
IDnumber
Create Whats App CampaignAction
Input fields[3]
FieldType
NameRequired
text
RecipientsRequired
object
Scheduled AtRequired
text
Template IDRequired
choice
Create Whatsapp TemplateAction
Input fields[3]
FieldType
Template NameRequired
text
LanguageRequired
text
CategoryRequired
choice
Body TextRequired
text
Header Texttext
Output fields[3]
FieldType
IDnumber
Nametext
Delete AttributeAction
Input fields[3]
FieldType
Attribute CategoryRequired
choice
Attribute NameRequired
text
Delete Attribute OptionAction
Input fields[3]
FieldType
Attribute TypeRequired
choice
Multiple Choice AttributeRequired
text
Option to DeleteRequired
text
Delete Balance DefinitionAction
Input fields[3]
FieldType
PidRequired
choice
BdidRequired
choice
Delete Balance LimitAction
Input fields[3]
FieldType
PidRequired
choice
BdidRequired
choice
BlidRequired
text
Delete Blocked ContactAction
Input fields[3]
FieldType
EmailRequired
email
Delete CompanyAction
Input fields[3]
FieldType
CompanyRequired
choice
Delete ContactAction
Input fields[3]
FieldType
IdentifierRequired
text
Delete Contact MembersAction
Input fields[3]
FieldType
PidRequired
choice
Delete Contact SubscriptionAction
Input fields[3]
FieldType
PidRequired
choice
CidRequired
choice
Delete Conversation MessageAction
Input fields[3]
FieldType
Message IDRequired
text
Delete CRM AttributesAction
Input fields[3]
FieldType
IDRequired
text
Delete CRM FileAction
Input fields[3]
FieldType
File IDRequired
text
Delete DealAction
Input fields[3]
FieldType
DealRequired
choice
Delete DomainAction
Input fields[3]
FieldType
Domain NameRequired
text
Delete Email CampaignAction
Input fields[3]
FieldType
Email CampaignRequired
choice
Delete Email LogAction
Input fields[3]
FieldType
IdentifierRequired
choice
From Datedate
To Datedate
Delete FeedAction
Input fields[3]
FieldType
External FeedRequired
choice
Delete FolderAction
Input fields[3]
FieldType
FolderRequired
choice
Delete GroupAction
Input fields[3]
FieldType
GroupRequired
choice
Delete Hard BouncesAction
Input fields[3]
FieldType
Start Datetext
End Datetext
Contact Emailemail
Delete ListAction
Input fields[3]
FieldType
ListRequired
choice
Delete Loyalty ProgramAction
Input fields[3]
FieldType
Loyalty ProgramRequired
choice
Delete NoteAction
Input fields[3]
FieldType
Note IDRequired
choice
Delete Object RecordsAction
Input fields[3]
FieldType
Object TypeRequired
text
IdentifiersRequired
object
IDsarray
External IDsarray
Output fields[3]
FieldType
Process IDnumber
Delete Payment RequestAction
Input fields[3]
FieldType
Payment Request IDRequired
text
Delete Pushed MessageAction
Input fields[3]
FieldType
Message IDRequired
text
Delete Scheduled EmailAction
Input fields[3]
FieldType
Batch ID or Message IDRequired
choice
Delete SenderAction
Input fields[3]
FieldType
SenderRequired
choice
Delete SMS CampaignAction
Input fields[3]
FieldType
Campaign IDRequired
choice
Delete Sub-AccountAction
Input fields[3]
FieldType
Sub-AccountRequired
choice
Delete TaskAction
Input fields[3]
FieldType
Task IDRequired
choice
Delete TemplateAction
Input fields[3]
FieldType
TemplateRequired
choice
Delete TierAction
Input fields[3]
FieldType
Loyalty ProgramRequired
choice
Tier IDRequired
text
Delete Tier GroupAction
Input fields[3]
FieldType
Loyalty ProgramRequired
choice
Tier Group IDRequired
text
Delete WebhookAction
Input fields[3]
FieldType
WebhookRequired
choice
Delete Whats App CampaignAction
Input fields[3]
FieldType
Campaign IDRequired
choice
Dissociate IP from Sub-AccountsAction
Input fields[3]
FieldType
IP AddressRequired
text
Sub-Account IDsRequired
array
Sub-Accountchoice
Download Inbound FileAction
Input fields[3]
FieldType
Download TokenRequired
text
Output fields[3]
FieldType
File Datatext
Export ContactsAction
Input fields[3]
FieldType
Custom Contact FilterRequired
object
Action For Contactschoice
Action For Email Campaignschoice
Action For SMS Campaignschoice
Listchoice
Segment IDnumber
Email Campaignchoice
SMS Campaignchoice
Export Attributesarray
Attributetext
Export Mandatory Attributesboolean
Export Metadataarray
Metadata Fieldtext
Export Date in UTCboolean
3other input fields
Output fields[3]
FieldType
Process IDnumber
Export Email RecipientsAction
Input fields[3]
FieldType
Email CampaignRequired
choice
Recipients TypeRequired
choice
Notify URLurl
Output fields[3]
FieldType
Process IDnumber
Export SMS RecipientsAction
Input fields[3]
FieldType
SMS CampaignRequired
choice
Recipients TypeRequired
choice
Notify URLurl
Output fields[3]
FieldType
Process IDnumber
Export Webhook LogsAction
Input fields[3]
FieldType
Event TypeRequired
choice
Notify URLRequired
url
Webhook TypeRequired
choice
Daysnumber
Start Datetext
5other input fields
Output fields[3]
FieldType
Process IDnumber
Generate Sub-Account SSOAction
Input fields[3]
FieldType
Sub-AccountRequired
choice
User Emailemail
Target Pagechoice
Target URLurl
Output fields[3]
FieldType
Tokentext
Import CompaniesAction
Input fields[3]
FieldType
File URLRequired
url
Column Mappingobject
Output fields[3]
FieldType
Process IDnumber
Import ContactsAction
Input fields[3]
FieldType
File URLurl
File Bodytext
JSON Bodyarray
Emailemail
Attributesobject
List IDsarray
Listchoice
New Listobject
List Nametext
Folderchoice
5other input fields
Output fields[3]
FieldType
Process IDnumber
Import CRM DealsAction
Input fields[3]
FieldType
File URLRequired
url
Column Mappingobject
Output fields[3]
FieldType
Process IDnumber
Invite Admin UserAction
Input fields[3]
FieldType
EmailRequired
email
All Features AccessRequired
boolean
Group IDsarray
Groupchoice
Privilegesarray
Featuretext
Permissionsarray
Output fields[3]
FieldType
IDtext
Invite Org UserAction
Input fields[3]
FieldType
EmailRequired
email
All Features AccessRequired
boolean
Privilegesarray
Featurechoice
Permissionsarray
Output fields[3]
FieldType
Statustext
Invoice IDtext
Link DealAction
Input fields[3]
FieldType
DealRequired
choice
Link Contact IDsarray
Contactchoice
Unlink Contact IDsarray
Contactchoice
Link Company IDsarray
Companychoice
Unlink Company IDsarray
Companychoice
Link or Unlink CompanyAction
Input fields[3]
FieldType
CompanyRequired
choice
Link Contact IDsarray
Contact IDnumber
Unlink Contact IDsarray
Contact IDnumber
Link Deal IDsarray
Deal IDtext
Unlink Deal IDsarray
Deal IDtext
Make an Api Calluniversal
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Status codenumber
Manage InvitationAction
Input fields[3]
FieldType
ActionRequired
choice
User EmailRequired
email
Output fields[3]
FieldType
Statustext
Credit Notesarray
Credit Notetext
Patch Loyalty ProgramAction
Input fields[3]
FieldType
Loyalty ProgramRequired
choice
Nametext
Descriptiontext
Metaobject
Output fields[3]
FieldType
IDtext
Nametext
Ping AgentAction
Input fields[3]
FieldType
Agent IDtext
Agent Emailemail
Agent Nametext
Received Fromtext
Preview Email TemplateAction
Input fields[3]
FieldType
TemplateRequired
choice
Contact Emailemail
Paramsobject
Output fields[3]
FieldType
From Emailemail
From Nametext
HTMLtext
Preview Texttext
Subjecttext
1other output field
Publish Loyalty ProgramAction
Input fields[3]
FieldType
PidRequired
choice
Redeem RewardAction
Input fields[3]
FieldType
Loyalty ProgramRequired
choice
Attributed Reward IDtext
Redemption Codetext
Contact IDnumber
Loyalty Subscription IDtext
2other input fields
Output fields[3]
FieldType
IDtext
Codetext
Statustext
Consumed Atdate
Remove from ListAction
Input fields[3]
FieldType
ListRequired
choice
Emailsarray
Emailemail
Contact IDsarray
Contact IDnumber
Output fields[3]
FieldType
Contactsobject
Failuretext
Process IDnumber
Successtext
Totalnumber
Resend or Cancel Admin InvitationAction
Input fields[3]
FieldType
ActionRequired
choice
User EmailRequired
email
Output fields[3]
FieldType
Messagetext
Revoke Admin UserAction
Input fields[3]
FieldType
User EmailRequired
email
Revoke Org User PermsAction
Input fields[3]
FieldType
User EmailRequired
email
Output fields[3]
FieldType
Statustext
Credit Notesarray
Credit Notetext
Revoke VouchersAction
Input fields[3]
FieldType
PidRequired
choice
Send Conversation MsgAction
Input fields[3]
FieldType
Visitor IDRequired
text
Message TextRequired
text
Agent IDtext
Agent Emailemail
Agent Nametext
1other input field
Output fields[3]
FieldType
IDtext
Texttext
HTMLtext
Agent IDtext
Created Atnumber
2other output fields
Send EmailAction
Input fields[3]
FieldType
Senderobject
Nametext
Emailemail
IDnumber
ToRequired
array
Emailemail
Nametext
BCCarray
Emailemail
Nametext
CCarray
Emailemail
Nametext
HTML Contenttext
11other input fields
Output fields[3]
FieldType
Message IDtext
Send Email CampaignAction
Input fields[3]
FieldType
Email CampaignRequired
choice
Send Email Campaign ReportAction
Input fields[3]
FieldType
Email CampaignRequired
choice
Languagechoice
EmailRequired
object
Toarray
Send Email Campaign TestAction
Input fields[3]
FieldType
Email CampaignRequired
choice
Email Toarray
Emailemail
Send Pushed MessageAction
Input fields[3]
FieldType
Agent IDtext
Agent Emailemail
Agent Nametext
Received Fromtext
Visitor IDRequired
text
1other input field
Output fields[3]
FieldType
IDtext
Texttext
Created Atnumber
Send SMSAction
Input fields[3]
FieldType
SenderRequired
text
RecipientRequired
text
Contenttext
Templatechoice
Typechoice
5other input fields
Output fields[3]
FieldType
Message IDnumber
Referencetext
SMS Countnumber
Used Creditsnumber
Remaining Creditsnumber
Send SMS AsyncAction
Input fields[3]
FieldType
SenderRequired
text
RecipientRequired
text
Contenttext
Templatechoice
Typechoice
5other input fields
Output fields[3]
FieldType
Message IDnumber
Send SMS CampaignAction
Input fields[3]
FieldType
SMS CampaignRequired
choice
Send SMS ReportAction
Input fields[3]
FieldType
SMS CampaignRequired
choice
Languagechoice
EmailRequired
object
Toarray
Send SMS TestAction
Input fields[3]
FieldType
SMS CampaignRequired
choice
Phone Numbertext
Send Test TemplateAction
Input fields[3]
FieldType
TemplateRequired
choice
Email Toarray
Emailemail
Send Whatsapp MessageAction
Input fields[3]
FieldType
Sender NumberRequired
text
Recipient NumbersRequired
array
Phone Numbertext
Template IDRequired
number
Paramsobject
Output fields[3]
FieldType
Message IDtext
Set Display CurrencyAction
Input fields[3]
FieldType
CurrencyRequired
text
Output fields[3]
FieldType
Codetext
Set Email Campaign StatusAction
Input fields[3]
FieldType
Email CampaignRequired
choice
StatusRequired
choice
Set Product AlertAction
Input fields[3]
FieldType
Product IDRequired
choice
Alert TypeRequired
choice
Enabledboolean
Set SMS Campaign StatusAction
Input fields[3]
FieldType
SMS CampaignRequired
choice
StatusRequired
choice
Submit Whatsapp Template ApprovalAction
Input fields[3]
FieldType
Template IDRequired
number
Subscribe Member to AsubscriptionAction
Input fields[3]
FieldType
PidRequired
choice
Contact IDchoice
Loyalty Subscription IDtext
Member Contact IdsRequired
array
Member Contact Idsnumber
Output fields[3]
FieldType
Organization IDnumber
Owner Contact IDnumber
Member Contact Idsarray
Member Contact IDnumber
Created Atdate
Updated Atdate
Subscribe to Loyalty ProgramAction
Input fields[3]
FieldType
PidRequired
choice
Contact IDRequired
choice
Loyalty Subscription IDtext
Creation Datetext
Metaobject
Output fields[3]
FieldType
Organization IDnumber
Loyalty Program IDtext
Version IDnumber
Contact IDnumber
Loyalty Subscription IDtext
3other output fields
Toggle Sub-Account AppsAction
Input fields[3]
FieldType
Sub-AccountRequired
choice
Automationboolean
Conversationsboolean
Sales CRMboolean
Email Campaignsboolean
9other input fields
Unblock a DomainAction
Input fields[3]
FieldType
DomainRequired
text
Unlink Group Sub-AccountsAction
Input fields[3]
FieldType
GroupRequired
choice
Sub-Account IDsRequired
array
Sub-Accountchoice
Update AttributeAction
Input fields[3]
FieldType
Attribute CategoryRequired
choice
Attribute NameRequired
text
Valuetext
Enumerationarray
Valuenumber
Labeltext
Multi Category Optionsarray
Optiontext
Update Balance DefinitionAction
Input fields[3]
FieldType
PidRequired
choice
BdidRequired
choice
Balance Availability Duration Modifiertext
Balance Availability Duration Unittext
Balance Availability Duration Valuenumber
13other input fields
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Image Refurl
Metaobject
15other output fields
Update Balance LimitAction
Input fields[3]
FieldType
PidRequired
choice
BdidRequired
choice
BlidRequired
text
Constraint TypeRequired
text
Duration UnitRequired
text
4other input fields
Output fields[3]
FieldType
IDtext
Balance Definition IDtext
Transaction Typetext
Constraint Typetext
Duration Valuenumber
5other output fields
Update CompanyAction
Input fields[3]
FieldType
CompanyRequired
choice
Attributesobject
Link Contact IDsarray
Contact IDnumber
Unlink Contact IDsarray
Contact IDnumber
Link Deal IDsarray
Deal IDtext
1other input field
Output fields[3]
FieldType
Attributesobject
IDtext
Linked Contacts Idsarray
Linked Contacts Idsnumber
Linked Deals Idsarray
Linked Deals Idstext
Update ContactAction
Input fields[3]
FieldType
IdentifierRequired
text
Identifier Typechoice
Attributesobject
Email Blacklistedboolean
SMS Blacklistedboolean
5other input fields
Update Conversation MessageAction
Input fields[3]
FieldType
Message IDRequired
text
Texttext
Output fields[3]
FieldType
IDtext
Texttext
Update Conversations VisitorgroupAction
Input fields[3]
FieldType
Group IDRequired
text
Output fields[3]
FieldType
Group IDtext
Visitor IDtext
Update Corporate User PermsAction
Input fields[3]
FieldType
User EmailRequired
email
All Features AccessRequired
boolean
Privilegesarray
Featurechoice
Permissionsarray
Update Coupon CollectionAction
Input fields[3]
FieldType
Coupon CollectionRequired
choice
Default Coupontext
Expiration Datedate
Remaining Coupons Alertnumber
Remaining Days Alertnumber
Output fields[3]
FieldType
IDtext
Nametext
Default Coupontext
Update CRM AttributeAction
Input fields[3]
FieldType
Attribute IDRequired
text
Labeltext
Update DealAction
Input fields[3]
FieldType
DealRequired
choice
Attributesobject
Linked Contact IDsarray
Contactchoice
Linked Company IDsarray
Companychoice
Unlinked Contact IDsarray
Contactchoice
1other input field
Update Email CampaignAction
Input fields[3]
FieldType
Email CampaignRequired
choice
Nametext
Subjecttext
Senderobject
Nametext
Emailemail
IDnumber
HTML Contenttext
22other input fields
Update FeedAction
Input fields[3]
FieldType
External FeedRequired
choice
Nametext
URLurl
Auth Typechoice
Usernametext
5other input fields
Update FolderAction
Input fields[3]
FieldType
FolderRequired
choice
NameRequired
text
Update GroupAction
Input fields[3]
FieldType
GroupRequired
choice
Group Nametext
Sub-Account IDsarray
Sub-Accountchoice
Update ListAction
Input fields[3]
FieldType
ListRequired
choice
Nametext
Folderchoice
Update Loyalty ProgramAction
Input fields[3]
FieldType
Loyalty ProgramRequired
choice
NameRequired
text
Descriptiontext
Metaobject
Output fields[3]
FieldType
IDtext
Nametext
Update NoteAction
Input fields[3]
FieldType
Note IDRequired
choice
Texttext
Contact IDsarray
Contactchoice
Company IDsarray
Companychoice
Deal IDsarray
Dealchoice
Update Org User PermissionsAction
Input fields[3]
FieldType
User EmailRequired
email
All Features AccessRequired
boolean
PrivilegesRequired
array
Featurechoice
Permissionsarray
Output fields[3]
FieldType
Statustext
Invoice IDtext
Credit Notesarray
Credit Notetext
Update Org User PermsAction
Input fields[3]
FieldType
User EmailRequired
email
All Features AccessRequired
boolean
PrivilegesRequired
array
Featurechoice
Permissionsarray
Output fields[3]
FieldType
Credit Notesarray
Credit Notestext
Invoice IDtext
Statustext
Update Pushed MessageAction
Input fields[3]
FieldType
Message IDRequired
text
Message Texttext
Output fields[3]
FieldType
IDtext
Texttext
Update SenderAction
Input fields[3]
FieldType
SenderRequired
choice
Nametext
Emailemail
IPsarray
IPtext
Domaintext
Weightnumber
Update SMS CampaignAction
Input fields[3]
FieldType
SMS CampaignRequired
choice
Nametext
Sendertext
Contenttext
Recipientsobject
List IDsarray
Exclusion List IDsarray
4other input fields
Update Sub-Account PlanAction
Input fields[3]
FieldType
Sub-AccountRequired
choice
Creditsobject
Email Creditsnumber
SMS Creditsnumber
WhatsApp Creditsnumber
WP Subscribers Creditsnumber
External Feeds Creditsnumber
Featuresobject
Inboxnumber
Landing Pagesnumber
Sales Usersnumber
Usersnumber
Update TaskAction
Input fields[3]
FieldType
Task IDRequired
choice
Nametext
Task Typechoice
Due Datedate
Duration (ms)number
7other input fields
Update TemplateAction
Input fields[3]
FieldType
TemplateRequired
choice
Template Nametext
Subjecttext
Senderobject
Nametext
Emailemail
IDnumber
HTML Contenttext
6other input fields
Update TierAction
Input fields[3]
FieldType
Loyalty ProgramRequired
choice
Tier IDRequired
text
NameRequired
text
Access ConditionsRequired
array
Balance Definition IDtext
Minimum Valuenumber
Tier RewardsRequired
array
Reward IDtext
1other input field
Output fields[3]
FieldType
IDtext
Nametext
Update Tier GroupAction
Input fields[3]
FieldType
Loyalty ProgramRequired
choice
Tier Group IDRequired
text
NameRequired
text
Upgrade StrategyRequired
choice
Downgrade StrategyRequired
choice
2other input fields
Output fields[3]
FieldType
IDtext
Nametext
Update WebhookAction
Input fields[3]
FieldType
WebhookRequired
choice
URLurl
Descriptiontext
Eventsarray
Eventchoice
Domaintext
3other input fields
Update Whats App CampaignAction
Input fields[3]
FieldType
Campaign IDRequired
choice
Campaign Nametext
Campaign Statustext
Recipientsobject
Reschedule Fortext
Upload CRM FileAction
Input fields[3]
FieldType
FileRequired
text
FilenameRequired
text
Contact IDnumber
Deal IDtext
Company IDtext
Output fields[3]
FieldType
IDtext
Nametext
Sizenumber
Upload Email ImageAction
Input fields[3]
FieldType
Image FileRequired
text
FilenameRequired
text
Output fields[3]
FieldType
Image URLurl
Upsert Object RecordsAction
Input fields[3]
FieldType
Object TypeRequired
text
RecordsRequired
array
Identifiersobject
Attributesobject
Associationsarray
Output fields[3]
FieldType
Messagetext
Process IDnumber
Validate RewardAction
Input fields[3]
FieldType
PidRequired
choice
Attributed Reward IDtext
Codetext
Contact IDchoice
Loyalty Subscription IDtext
2other input fields
Output fields[3]
FieldType
Authorizeboolean
Validate Sender OTPAction
Input fields[3]
FieldType
SenderRequired
choice
OTPRequired
number

Look for Brevo templates in the WEXTL template library.

Browse templates →
  1. WEXTL® Brevo Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for Brevo.
  4. WEXTL® visual workflow builder data.

Last updated: Jul 22, 2026 23:18