The Brevo connector lets your AI agent act in each user's Brevo account. Each user connects their own Brevo API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 65 tools.
- Tools
- 65
- What they doRead · write · destructive
- 30 · 26 · 930 read26 write9 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Brevo connection
In AgentKit > Connections, create a Brevo connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'brevo'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Brevo:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'brevo_account_get',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "brevo"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Brevo:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="brevo_account_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Brevo credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolbrevo_account_getRetrieve the Brevo account's company details, plan and credits.Read-onlyGet Account
Retrieve the Brevo account's company details, plan and credits. Returns email, firstName, lastName, companyName, address, plan (type, credits, creditsType per channel) and relay (SMTP relay settings).
Inputs
This tool takes no inputs.
brevo_blocked_contacts_listList contacts blocked or unsubscribed from transactional email (hard bounces, spam complaints, unsubscribes, admin blocks).Read-onlyList Blocked Transactional Contacts
List contacts blocked or unsubscribed from transactional email (hard bounces, spam complaints, unsubscribes, admin blocks). Returns count and contacts, an array with email, senderEmail, reason (code and message) and blockedAt.
Inputs
end_datestring- Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts. Example: 2026-11-13
limitinteger- Number of documents returned per page. Example: 50
offsetinteger- Index of the first document on the page. Example: 0
sendersarray- Comma separated list of emails of the senders from which contacts are blocked or unsubscribed. Example: ["news@example.com"]
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed. Example: descone of
ascdesc start_datestring- Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts. Example: 2026-11-01
brevo_contact_attributes_listList the contact attributes (fields) defined in the account.Read-onlyList Contact Attributes
List the contact attributes (fields) defined in the account. Returns attributes, an array with name, category (normal, transactional, category, calculated, global), type and enumeration.
Inputs
This tool takes no inputs.
brevo_contact_campaign_stats_getGet one contact's email campaign activity (messages sent, opened, clicked, bounced, unsubscribed) over up to 90 days.Read-onlyGet Contact Campaign Statistics
Get one contact's email campaign activity (messages sent, opened, clicked, bounced, unsubscribed) over up to 90 days. Returns messagesSent, opened, clicks, hardBounces, softBounces, complaints, unsubscriptions and delivered, each with campaignId and event time.
Inputs
identifierstringrequired- Contact identifier: email address, numeric contact ID, ext_id, phone_id, whatsapp_id or landline_number_id (set identifier_type for the non-email kinds) Example: jane@example.com
end_datestring- Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Must not be greater than the current date. Maximum difference between startDate and endDate should not be greater than 90 days. Example: 2026-11-13
start_datestring- Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate. Must not be greater than the current date. Example: 2026-11-01
brevo_contact_getRetrieve one contact by email, ID, ext_id or phone.Read-onlyGet Contact
Retrieve one contact by email, ID, ext_id or phone. Returns id, email, emailBlacklisted, smsBlacklisted, attributes, listIds, listUnsubscribed, createdAt, modifiedAt and statistics.
Inputs
identifierstringrequired- Contact identifier: email address, numeric contact ID, ext_id, phone_id, whatsapp_id or landline_number_id (set identifier_type for the non-email kinds) Example: jane@example.com
end_datestring- Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Must not be greater than the current date. Example: 2026-11-13
identifier_typestring- Email_id for Email, phone_id for SMS attribute, contact_id for ID of the contact, ext_id for EXT_ID attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE_NUMBER attribute. Example: email_idone of
email_idphone_idcontact_idext_idwhatsapp_idlandline_number_id start_datestring- Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate. Must not be greater than the current date. Example: 2026-11-01
brevo_contacts_listList contacts, optionally modified or created since a date, in specific lists or segments, or matching attribute filters.Read-onlyList Contacts
List contacts, optionally modified or created since a date, in specific lists or segments, or matching attribute filters. Returns count and contacts, an array with id, email, emailBlacklisted, smsBlacklisted, attributes, listIds, createdAt and modifiedAt. Use brevo_contact_get for one contact by email or ID.
Inputs
created_sincestring- Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. Example: 2026-11-01T00:00:00Z
filterstring- Filter contacts by an attribute value with the equals operator, for example equals(FIRSTNAME,"Jane"), equals(B1, true) or equals(COUNTRY,"USA, INDIA"). Multiple-choice options are combined with AND; category attributes match by id or value. Example: equals(FIRSTNAME,"Jane")
idsarray- Filter by a list of contact IDs. You can pass a maximum of 20 IDs. All elements must be integers. Example: [42]
limitinteger- Number of documents per page. Example: 50
list_idsarray- Ids of the list. Either listIds or segmentId can be passed. Example: [12]
modified_sincestring- Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. Example: 2026-11-01T00:00:00Z
offsetinteger- Index of the first document of the page. Example: 0
segment_idinteger- Id of the segment. Either listIds or segmentId can be passed. Must be a positive integer (minimum value of 1). Example: 123
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed. Example: descone of
ascdesc
brevo_domain_getRetrieve a sender domain's DNS records (Brevo code, DKIM, DMARC, SPF) and their status.Read-onlyGet Sender Domain
Retrieve a sender domain's DNS records (Brevo code, DKIM, DMARC, SPF) and their status. Returns domain, verified, authenticated and dns_records (each with type, value, host_name and status).
Inputs
domain_namestringrequired- Domain name. Example: mail.example.com
brevo_domains_listList sender domains with their authentication status.Read-onlyList Sender Domains
List sender domains with their authentication status. Returns domains, an array with id, domain_name, authenticated, verified and ip.
Inputs
This tool takes no inputs.
brevo_email_campaign_getRetrieve one email campaign with its content, recipients and statistics.Read-onlyGet Email Campaign Report
Retrieve one email campaign with its content, recipients and statistics. Returns id, name, subject, status, scheduledAt, sender, htmlContent, recipients and statistics (globalStats, campaignStats, linksStats).
Inputs
campaign_idintegerrequired- Id of the campaign. Example: 34
exclude_html_contentboolean- Use this flag to exclude htmlContent from the response body. If set to true, htmlContent field will be returned as empty string in the response body. Example: true
statisticsstring- Filter on the type of statistics required. Example: globalStats value will only fetch globalStats info of the campaign in the returned response. statsByDevice and statsByBrowser are only available when retrieving a single campaign (not in the list endpoint). Example: globalStatsone of
globalStatslinksStatsstatsByDomainstatsByDevicestatsByBrowser
brevo_email_campaigns_listList email campaigns, optionally by type, status or date range.Read-onlyList Email Campaigns
List email campaigns, optionally by type, status or date range. Returns count and campaigns, an array with id, name, subject, type, status, scheduledAt, sender, recipients and statistics (when requested). Use brevo_email_campaign_get for one campaign's report.
Inputs
end_datestring- Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result. Only available if status is not passed or is set to sent. The date range between startDate and endDate must not exceed 2 years. endDate must not be in the future. Example: 2026-11-13
exclude_html_contentboolean- Use this flag to exclude htmlContent from the response body. If set to true, the htmlContent field will be returned as an empty string in the response body. Example: true
exclude_pdf_attachmentboolean- Use this flag to filter out campaigns that have a PDF attachment. If set to true, only campaigns without a PDF attachment (or with no attachment at all) will be returned. Example: true
limitinteger- Number of documents per page. Example: 50
offsetinteger- Index of the first document in the page. Example: 0
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed. Example: descone of
ascdesc start_datestring- Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result. Only available if status is not passed or is set to sent. The date range between startDate and endDate must not exceed 2 years. startDate must not be in the future. Example: 2026-11-01
statisticsstring- Filter on the type of statistics required. Example: globalStats value will only fetch globalStats info of the campaign in the returned response. This option only returns data for events that occurred in the last 6 months. For older campaigns, it is advisable to use the Get Campaign Report endpoint. Example: globalStatsone of
globalStatslinksStatsstatsByDomain statusstring- Filter on the status of the campaign. Example: sentone of
suspendedarchivesentqueueddraftinProcessinReviewcancellingcancelled typestring- Filter on the type of the campaigns. Example: classicone of
classictrigger
brevo_email_events_listList individual transactional email events (sent, delivered, opened, clicked, bounced, spam, blocked, unsubscribed and more), filtered by email, event, tags, message ID or template.Read-onlyList Email Events
List individual transactional email events (sent, delivered, opened, clicked, bounced, spam, blocked, unsubscribed and more), filtered by email, event, tags, message ID or template. Returns events, an array with email, date, messageId, event, reason, tag, ip, link, from and templateId.
Inputs
daysinteger- Number of days in the past including today (positive integer, maximum 90). _Not compatible with 'startDate' and 'endDate'_. Defaults to 30 if neither dates nor days are provided. Example: 7
emailstring- Filter the report for a specific email addresses. Example: jane@example.com
end_datestring- Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate. Example: 2026-11-13
eventstring- Filter the report for a specific event type. Example: deliveredone of
bounceshardBouncessoftBouncesdeliveredspamrequestsopenedclicksinvaliddeferredblockedunsubscribederrorloadedByProxy limitinteger- Number limitation for the result returned. Example: 50
message_idstring- Filter on a specific message id. Example: <201798300811.5787683@relay.domain.com>
offsetinteger- Beginning point in the list to retrieve from. Example: 0
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed. Example: descone of
ascdesc start_datestring- Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate. Example: 2026-11-01
tagsstring- Filter the report for tags (serialized and urlencoded array) Example: ["password-reset"]
template_idinteger- Filter on a specific template id. Example: 7
brevo_email_stats_aggregated_getGet transactional email totals (requests, delivered, hard and soft bounces, clicks, opens, spam reports, blocked, invalid, unsubscribed) over a period.Read-onlyGet Email Statistics Summary
Get transactional email totals (requests, delivered, hard and soft bounces, clicks, opens, spam reports, blocked, invalid, unsubscribed) over a period. Returns range plus one count per event type. Use brevo_email_events_list for individual events.
Inputs
daysinteger- Number of days in the past including today (positive integer, maximum 90). _Not compatible with 'startDate' and 'endDate'_. Defaults to 90 if neither dates nor days are provided. Example: 7
end_datestring- Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate. Example: 2026-11-13
start_datestring- Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate. Example: 2026-11-01
tagstring- Tag of the emails. Example: password-reset
brevo_email_template_getRetrieve one email template, including its HTML.Read-onlyGet Email Template
Retrieve one email template, including its HTML. Returns id, name, subject, isActive, sender, replyTo, toField, tag, htmlContent and dates.
Inputs
template_idstringrequired- ID of the template. Can be a numeric template ID or a custom template identifier string (alphanumeric, hyphens, and underscores only, max 64 characters, must start with a letter). Example: 7
brevo_email_template_previewRender a transactional template for an existing contact, with optional params, without sending.Read-onlyPreview Email Template
Render a transactional template for an existing contact, with optional params, without sending. Returns html, subject, previewText and the sender, replyTo and toField used. Requires the email of an existing contact; Brevo rejects params alone with "Contact not found".
Inputs
emailstringrequired- Email of an existing contact; Brevo renders the template with this contact's data. Example: jane@example.com
template_idintegerrequired- Id of the template. Example: 7
paramsobject- Key-value pairs of dynamic parameters for template rendering, used together with email. For example: {"Firstname":"John", "Lastname":"Doe"}. Example: {"ORDER_ID": "A1001"}
brevo_email_templates_listList transactional email templates.Read-onlyList Email Templates
List transactional email templates. Returns count and templates, an array with id, name, subject, isActive, testSent, sender, replyTo, toField, tag, htmlContent, createdAt and modifiedAt.
Inputs
editor_typestring- Filter on the editor type used to create the template. Currently only richTextEditor is supported as a filter value. Example: richTextEditorone of
richTextEditor limitinteger- Number of documents returned per page. Example: 50
offsetinteger- Index of the first document in the page. Example: 0
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed. Example: descone of
ascdesc template_statusboolean- Filter on the status of the template. Active = true, inactive = false. Example: true
brevo_folders_listList the folders that group contact lists.Read-onlyList Contact Folders
List the folders that group contact lists. Returns count and folders, an array with id, name, uniqueSubscribers, totalSubscribers and totalBlacklisted.
Inputs
limitinteger- Number of documents per page. Example: 50
offsetinteger- Index of the first document of the page. Example: 0
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed. Example: descone of
ascdesc
brevo_list_contacts_listList the contacts in one contact list.Read-onlyList Contacts in List
List the contacts in one contact list. Returns count and contacts, an array with id, email, emailBlacklisted, smsBlacklisted, attributes, listIds and modifiedAt.
Inputs
list_idintegerrequired- Id of the list. Example: 12
limitinteger- Number of documents per page. Example: 50
modified_sincestring- Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. Example: 2026-11-01T00:00:00Z
offsetinteger- Index of the first document of the page. Example: 0
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed. Example: descone of
ascdesc
brevo_list_getRetrieve one contact list with its counts and the campaigns sent to it.Read-onlyGet Contact List
Retrieve one contact list with its counts and the campaigns sent to it. Returns id, name, folderId, createdAt, campaignStats, dynamicList, uniqueSubscribers, totalBlacklisted and totalSubscribers.
Inputs
list_idintegerrequired- Id of the list. Example: 12
end_datestring- Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a specific list id. Prefer to pass your timezone in date-time format for accurate result. Example: 2026-11-13
start_datestring- Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a specific list id. Prefer to pass your timezone in date-time format for accurate result. Example: 2026-11-01
brevo_lists_listList contact lists.Read-onlyList Contact Lists
List contact lists. Returns count and lists, an array with id, name, folderId, uniqueSubscribers, totalBlacklisted and totalSubscribers.
Inputs
limitinteger- Number of documents per page. Example: 50
offsetinteger- Index of the first document of the page. Example: 0
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed. Example: descone of
ascdesc
brevo_scheduled_email_getGet the status of scheduled transactional emails by batch ID or message ID.Read-onlyGet Scheduled Email Status
Get the status of scheduled transactional emails by batch ID or message ID. Returns count and batches (each with scheduledAt, createdAt, status) or the single email's status.
Inputs
identifierstringrequired- batchId of the scheduled batch, or messageId of one scheduled email. Example: 5c6cfa04-eed9-42c2-8b5c-6d470d978e9d
end_datestring- Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. Example: 2026-11-13
limitinteger- Number of documents returned per page. Not valid when identifier is messageId. Example: 50
offsetinteger- Index of the first document on the page. Not valid when identifier is messageId. Example: 0
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed. Not valid when identifier is messageId. Example: descone of
ascdesc start_datestring- Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Cannot be more than 30 days older than the current date. Example: 2026-11-01
statusstring- Filter the records by status of the scheduled email batch or message. Not valid when identifier is messageId. Example: processedone of
processedinProgressqueued
brevo_segments_listList contact segments.Read-onlyList Segments
List contact segments. Returns count and segments, an array with id, segmentName, categoryName and updatedAt.
Inputs
limitinteger- Number of documents per page. Example: 50
offsetinteger- Index of the first document of the page. Example: 0
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed. Example: descone of
ascdesc
brevo_senders_listList the email senders in the account.Read-onlyList Senders
List the email senders in the account. Returns senders, an array with id, name, email, active and ips.
Inputs
domainstring- Filter your senders for a specific domain. Example: example.com
ipstring- Filter your senders for a specific ip. Available for dedicated IP usage only. Example: 123.98.689.7
brevo_sms_campaign_getRetrieve one SMS campaign with its recipients and statistics.Read-onlyGet SMS Campaign
Retrieve one SMS campaign with its recipients and statistics. Returns id, name, status, content, scheduledAt, sender, recipients and statistics (delivered, sent, processing, softBounces, hardBounces, unsubscriptions, answered).
Inputs
campaign_idintegerrequired- Id of the SMS campaign. Example: 34
brevo_sms_campaigns_listList SMS campaigns, optionally by status or date range.Read-onlyList SMS Campaigns
List SMS campaigns, optionally by status or date range. Returns count and campaigns, an array with id, name, status, content, scheduledAt, sender, recipients and statistics.
Inputs
end_datestring- Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent SMS campaigns. Prefer to pass your timezone in date-time format for accurate result. Only available if status is not passed or is set to sent. endDate must not be in the future. Example: 2026-11-13
limitinteger- Number of documents per page. Example: 50
offsetinteger- Beginning point in the list to retrieve from. Example: 0
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed. Example: descone of
ascdesc start_datestring- Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent SMS campaigns. Prefer to pass your timezone in date-time format for accurate result. Only available if status is not passed or is set to sent. startDate must not be in the future. Example: 2026-11-01
statusstring- Status of campaign. Example: sentone of
suspendedarchivesentqueueddraftinProcess
brevo_sms_events_listList individual transactional SMS events, filtered by phone number, event, tags or date range.Read-onlyList SMS Events
List individual transactional SMS events, filtered by phone number, event, tags or date range. Returns events, an array with phoneNumber, date, messageId, event, reason, reply and tag.
Inputs
daysinteger- Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'. Example: 7
end_datestring- Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report. Example: 2026-11-13
eventstring- Filter the report for specific events. Example: deliveredone of
bounceshardBouncessoftBouncesdeliveredsentacceptedunsubscriptionrepliesblockedrejectedskipped limitinteger- Number of documents per page. Example: 50
offsetinteger- Index of the first document of the page. Example: 0
phone_numberstring- Filter the report for a specific phone number. Example: +33612345678
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed. Example: descone of
ascdesc start_datestring- Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report. Example: 2026-11-01
tagsstring- Filter the report for specific tags passed as a serialized urlencoded array. Example: ["password-reset"]
brevo_sms_stats_aggregated_getGet transactional SMS totals (requests, delivered, hard and soft bounces, blocked, unsubscribed, replied, accepted, rejected) over a period.Read-onlyGet SMS Statistics Summary
Get transactional SMS totals (requests, delivered, hard and soft bounces, blocked, unsubscribed, replied, accepted, rejected) over a period. Returns range plus one count per event type.
Inputs
daysinteger- Number of days in the past including today (positive integer). Not compatible with startDate and endDate. Example: 7
end_datestring- Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report. Example: 2026-11-13
start_datestring- Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report. Example: 2026-11-01
tagstring- Filter on a tag. Example: password-reset
brevo_transactional_email_content_getRetrieve the personalized content and event history of one sent transactional email.Read-onlyGet Transactional Email Content
Retrieve the personalized content and event history of one sent transactional email. Returns email, subject, templateId, date, events (name, time) and body (the rendered HTML).
Inputs
uuidstringrequired- uuid of the email from brevo_transactional_emails_list. Example: 4566d9a5-3f0e-4f8c-9f8a-1b2c3d4e5f60
brevo_transactional_emails_listList sent transactional emails filtered by recipient, template, message ID or date range.Read-onlyList Transactional Emails
List sent transactional emails filtered by recipient, template, message ID or date range. Returns count and transactionalEmails, an array with email, subject, templateId, messageId, uuid, date, from and tags. Use brevo_transactional_email_content_get with a uuid for the rendered content.
Inputs
emailstring- Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent. Example: jane@example.com
end_datestring- Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. Example: 2026-11-13
limitinteger- Number of documents returned per page. Example: 50
message_idstring- Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. Example: <201798300811.5787683@relay.domain.com>
offsetinteger- Index of the first document in the page. Example: 0
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed. Example: descone of
ascdesc start_datestring- Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. Example: 2026-11-01
template_idinteger- Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email. Example: 7
brevo_webhook_getRetrieve one webhook.Read-onlyGet Webhook
Retrieve one webhook. Returns id, url, description, events, type, batched, headers and auth.
Inputs
webhook_idintegerrequired- Id of the webhook. Example: 56
brevo_webhooks_listList webhooks for transactional, marketing or inbound events.Read-onlyList Webhooks
List webhooks for transactional, marketing or inbound events. Returns webhooks, an array with id, url, description, events, type, createdAt, modifiedAt and auth. When the account has no webhooks, Brevo returns a "Webhook record does not exist" error instead of an empty list.
Inputs
sortstring- Sort the results in the ascending/descending order of webhook creation. Example: descone of
ascdesc typestring- Filter on webhook type. Example: transactionalone of
marketingtransactionalinbound
brevo_contact_attribute_createCreate a contact attribute (a custom contact field).WriteCreate Contact Attribute
Create a contact attribute (a custom contact field). Returns no content (201).
Inputs
attribute_categorystringrequired- Category of the attribute. Example: normalone of
normaltransactionalcategorycalculatedglobal attribute_namestringrequired- Name of the attribute. Example: PLAN
enumerationarray- List of values and labels that the attribute can take. Use only if the attribute's category is "category". None of the category options can exceed max 200 characters. For example: [{"value":1, "label":"male"}, {"value":2, "label":"female"}]. Example: [{"value": 1, "label": "Free"}]
is_recurringboolean- Type of the attribute. Use only if the attribute's category is 'calculated' or 'global'. Example: true
multi_category_optionsarray- List of options you want to add for multiple-choice attribute. Use only if the attribute's category is "normal" and attribute's type is "multiple-choice". None of the multicategory options can exceed max 200 characters. For example: ["USA","INDIA"]. Example: ["red", "blue"]
typestring- Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' Type user and multiple-choice is only available if the category is normal attribute Type id is only available if the category is transactional attribute Type category is only available if the category is category attribute. Example: textone of
textdatefloatbooleanidcategorymultiple-choiceuser valuestring- Value of the attribute. Use only if the attribute's category is 'calculated' or 'global'. Example: [BLOCKED]
brevo_contact_createCreate a contact with attributes and list memberships, or update it when update_enabled is true.WriteCreate Contact
Create a contact with attributes and list memberships, or update it when update_enabled is true. Returns id of the created contact (204 with no body when an existing contact was updated).
Inputs
attributesobject- Pass the set of attributes and their values. The attribute's parameter should be passed in capital letter while creating a contact. Values that don't match the attribute type (e.g. text or string in a date attribute) will be ignored. These attributes must be present in your Brevo account. For eg: {"FNAME":"Elly", "LNAME":"Roger", "COUNTRIES": ["India","China"]}. Example: {"FIRSTNAME": "Jane", "LASTNAME": "Doe", "SMS": "+33612345678"}
emailstring- Email address of the user. Mandatory if "ext_id" & "SMS" field is not passed. Example: jane@example.com
email_blacklistedboolean- Set this field to blacklist the contact for emails (emailBlacklisted = true) Example: false
ext_idstring- Pass your own Id to create a contact. Example: crm-1001
force_mergeboolean- When true, if the contact being created shares an identifier (email, SMS, ext_id, whatsapp, landline) with an existing contact, the two contacts are force-merged. The contact with the most recent last_modified timestamp is retained; the other is deleted. When false (default), a 4xx error is returned on identifier conflict. Example: true
get_idboolean- When true, the response returns the id of the surviving contact after merge. Example: true
list_idsarray- Ids of the lists to add the contact to. Example: [12]
sms_blacklistedboolean- Set this field to blacklist the contact for SMS (smsBlacklisted = true) Example: false
smtp_blacklist_senderarray- Transactional email forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true ) Example: ["news@example.com"]
update_enabledboolean- Facilitate to update the existing contact in the same request (updateEnabled = true) Example: false
brevo_contact_doi_createStart the double opt-in flow: Brevo emails the address a confirmation link and adds it to the lists after it is clicked.WriteCreate Contact via Double Opt-In
Start the double opt-in flow: Brevo emails the address a confirmation link and adds it to the lists after it is clicked. Returns no content (201/204).
Inputs
emailstringrequired- Email address where the confirmation email will be sent. This email address will be the identifier for all other contact attributes. Example: jane@example.com
include_list_idsarrayrequired- Lists under user account where contact should be added. Example: [12]
redirection_urlstringrequired- URL of the web page that user will be redirected to after clicking on the double opt in URL. When editing your DOI template you can reference this URL by using the tag {{ params.DOIurl }}. Example: https://example.com/confirmed
template_idintegerrequired- ID of a double opt-in confirmation template (with the DOI tag) Example: 9
attributesobject- Pass the set of attributes and their values. These attributes must be present in your Brevo account. For eg. {'FNAME':'Elly', 'LNAME':'Roger', 'COUNTRIES': ['India','China']}. Example: {"FIRSTNAME": "Jane", "LASTNAME": "Doe", "SMS": "+33612345678"}
contact_pixel_tracking_consentboolean- Consent of the DOI recipient for open (pixel) and click tracking in the double opt-in confirmation email, resolved by the sender at send time. Considered only if the per-contact pixel tracking consent feature is enabled for your account. Pass true if this recipient has consented to open and click tracking, in which case the open pixel and tracked links identify the recipient. Example: true
exclude_list_idsarray- Lists under user account where contact should not be added. Example: [13]
brevo_contact_updateUpdate a contact's attributes, list memberships or blocklist flags.WriteUpdate Contact
Update a contact's attributes, list memberships or blocklist flags. Returns no content (204).
- Idempotent
Inputs
identifierstringrequired- Contact identifier: email address, numeric contact ID, ext_id, phone_id, whatsapp_id or landline_number_id (set identifier_type for the non-email kinds) Example: jane@example.com
attributesobject- Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attributes. For example, { "EMAIL":"newemail@domain.com", "FNAME":"Ellie", "LNAME":"Roger", "COUNTRIES":["India","China"]}. The attribute's parameter should be passed in capital letter while updating a contact. Example: {"FIRSTNAME": "Jane", "LASTNAME": "Doe", "SMS": "+33612345678"}
email_blacklistedboolean- Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true) Example: false
ext_idstring- Pass your own Id to update ext_id of a contact. Example: crm-1001
force_mergeboolean- When true, if the contact being updated shares an identifier (email, SMS, ext_id, whatsapp, landline) with an existing contact, the two contacts are force-merged. The contact with the most recent last_modified timestamp is retained; the other is deleted. When false (default), a 4xx error is returned on identifier conflict. Example: true
identifier_typestring- Email_id for Email, contact_id for ID of the contact, ext_id for EXT_ID attribute, phone_id for SMS attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE_NUMBER attribute. Example: email_idone of
email_idcontact_idext_idphone_idwhatsapp_idlandline_number_id list_idsarray- Ids of the lists to add the contact to. Example: [12]
sms_blacklistedboolean- Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true) Example: true
smtp_blacklist_senderarray- Transactional email forbidden sender for contact. Use only for email Contact. Example: ["news@example.com"]
unlink_list_idsarray- Ids of the lists to remove the contact from. Example: [13]
brevo_domain_authenticateCheck a sender domain's DNS records now and mark it authenticated when they match.WriteAuthenticate Sender Domain
Check a sender domain's DNS records now and mark it authenticated when they match. Returns domain_name and message.
- Idempotent
Inputs
domain_namestringrequired- Domain name. Example: mail.example.com
brevo_domain_createAdd a sender domain.WriteCreate Sender Domain
Add a sender domain. Publish the returned DNS records, then call brevo_domain_authenticate. Returns id, domain_name, message and dns_records.
Inputs
namestringrequired- Domain name to be added. Example: mail.example.com
brevo_email_campaign_createCreate an email campaign (draft, or scheduled when scheduled_at is set) for contact lists or segments.WriteCreate Email Campaign
Create an email campaign (draft, or scheduled when scheduled_at is set) for contact lists or segments. Returns id of the new campaign. Send it with brevo_email_campaign_send_now or schedule it with scheduled_at.
Inputs
namestringrequired- Name of the campaign. Example: November newsletter
senderobjectrequired- Sender: an object with name and email, or id of a saved sender. Example: {"name": "Acme", "email": "news@example.com"}
attachment_urlstring- Absolute url of the attachment (no local file). Extension allowed: #### xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps. Example: https://example.com/brochure.pdf
email_expiration_dateobject- To reduce your carbon footprint, set an expiration date for your email. If supported, it will be automatically deleted from the recipient’s inbox, saving storage space and energy. Learn more about setting an email expiration date. For reference , https://help.brevo.com/hc/en-us/articles/4413566705298-Create-an-email-campaign. Example: {"duration": 3, "unit": "days"}
footerstring- Footer of the email campaign. Example: [DEFAULT_FOOTER]
headerstring- Header of the email campaign. Example: [DEFAULT_HEADER]
html_contentstring- Mandatory if htmlUrl and templateId are empty. Body of the message (HTML). Must have more than 10 characters and be less than 1MB in size. Cannot be used together with htmlUrl or templateId. Example: <html><body><p>Hello {{ contact.FIRSTNAME }}</p></body></html>
html_urlstring- Mandatory if htmlContent and templateId are empty. URL to the message (HTML). Cannot be used together with htmlContent or templateId. For example: https://html.domain.com. Example: https://example.com/campaign.html
inline_image_activationboolean- Use true to embedded the images in your email. Final size of the email should be less than 4MB. Campaigns with embedded images can _not be sent to more than 5000 contacts_. Example: true
mirror_activeboolean- Use true to enable the mirror link. Example: true
paramsobject- Pass the set of attributes to customize the type classic campaign. For example: {"FNAME":"Joe", "LNAME":"Doe"}. Only available if type is classic. It's considered only if campaign is in _New Template Language format_. The New Template Language is dependent on the values of subject, htmlContent/htmlUrl, sender.name & toField. Example: {"ORDER_ID": "A1001"}
preview_textstring- Preview text or preheader of the email campaign. Example: This month's top picks
recipientsobject- Who to send to: an object with listIds (array of list IDs), optional exclusionListIds and segmentIds. Example: {"listIds": [12], "exclusionListIds": [13]}
reply_tostring- Email on which the campaign recipients will be able to reply to. Example: help@example.com
scheduled_atstring- Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). For example: 2017-06-01T12:30:00+02:00. Example: 2026-11-20T09:00:00+01:00
send_at_best_timeboolean- Set this to true if you want to send your campaign at best time. Example: true
subjectstring- Subject of the campaign. Mandatory if abTesting is false. Ignored if abTesting is true. Example: November news
tagstring- Tag of the campaign. Example: newsletter
template_idinteger- Mandatory if htmlContent and htmlUrl are empty. Id of the transactional email template with status _active_. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature. Cannot be used together with htmlContent or htmlUrl. Example: 7
to_fieldstring- To personalize the To Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your Brevo account. If input parameter params used please use {{contact.FNAME}} {{contact.LNAME}} for personalization. Example: {{contact.FIRSTNAME}}
unsubscription_page_idstring- Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page. If not entered, then the default unsubscription page will be used. Example: 62cbb7fabbe85021021aac52
update_form_idstring- Mandatory if templateId is used containing the {{ update_profile }} tag. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form. If not entered, then the default update profile form will be used. Example: 6313436b9ba0a5213a7a2d1b
utm_campaignstring- Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed. Example: november-news
utm_contentstring- Customize the utm_content value. Appears on outgoing tracking links alongside utm_campaign. Only alphanumeric characters and spaces are allowed. Example: header-link
utm_idstring- Customize the utm_id value. Appears on outgoing tracking links alongside utm_campaign. When omitted or empty, the utm_id entry from the account's global utm_settings is used if enabled; otherwise no utm_id parameter is emitted. Example: 42
utm_mediumstring- Customize the utm_medium value. When omitted or empty, the utm_medium entry from the account's global utm_settings is used if set; otherwise the default email is used. Example: email
utm_sourcestring- Customize the utm_source value. When omitted or empty, the utm_source entry from the account's global utm_settings is used if set; otherwise the account default (brevo or sendinblue) is used. Example: brevo
utm_termstring- Customize the utm_term value. Appears on outgoing tracking links alongside utm_campaign. Only alphanumeric characters and spaces are allowed. Example: sale
brevo_email_campaign_send_nowSend an email campaign to its recipients immediately.WriteSend Email Campaign Now
Send an email campaign to its recipients immediately. Returns no content (204). Spends email credits.
Inputs
campaign_idintegerrequired- Id of the campaign. Example: 34
brevo_email_campaign_send_testSend a test of an email campaign to specific addresses (or the test list).WriteSend Email Campaign Test
Send a test of an email campaign to specific addresses (or the test list). Returns no content (204).
Inputs
campaign_idintegerrequired- Id of the campaign. Example: 34
email_toarray- List of the email addresses of the recipients whom you wish to send the test mail. _If left empty, the test mail will be sent to your entire test list. You can not send more than 50 test emails per day_. Example: ["qa@example.com"]
brevo_email_campaign_status_updateChange an email campaign's status, for example suspend a scheduled campaign, archive it or put it back to draft.WriteUpdate Email Campaign Status
Change an email campaign's status, for example suspend a scheduled campaign, archive it or put it back to draft. Returns no content (204).
- Idempotent
Inputs
campaign_idintegerrequired- Id of the campaign. Example: 34
statusstring- Note:- replicateTemplate status will be available only for template type campaigns. Example: suspendedone of
suspendedarchivedarchivesentqueuedreplicatereplicateTemplatecanceldraft
brevo_email_campaign_updateChange a draft or scheduled email campaign's name, subject, sender, content, recipients or schedule.WriteUpdate Email Campaign
Change a draft or scheduled email campaign's name, subject, sender, content, recipients or schedule. Returns no content (204).
- Idempotent
Inputs
campaign_idintegerrequired- Id of the campaign. Example: 34
attachment_urlstring- Absolute url of the attachment (no local file). Extension allowed: #### xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps'. Example: https://example.com/brochure.pdf
email_expiration_dateobject- To reduce your carbon footprint, set an expiration date for your email. If supported, it will be automatically deleted from the recipient’s inbox, saving storage space and energy. Example: {"duration": 3, "unit": "days"}
footerstring- Footer of the email campaign. Example: [DEFAULT_FOOTER]
headerstring- Header of the email campaign. Example: [DEFAULT_HEADER]
html_contentstring- Body of the message (HTML version). If the campaign is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that campaign. REQUIRED if htmlUrl is empty. Example: <html><body><p>Hello {{ contact.FIRSTNAME }}</p></body></html>
html_urlstring- Url which contents the body of the email message. REQUIRED if htmlContent is empty. Example: https://example.com/campaign.html
inline_image_activationboolean- Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. You cannot send a campaign of more than 4MB with images embedded in the email. Campaigns with the images embedded in the email _must be sent to less than 5000 contacts_. Example: true
mirror_activeboolean- Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign. Example: true
namestring- Name of the campaign. Example: November newsletter
paramsobject- Pass the set of attributes to customize the type classic campaign. For example: {"FNAME":"Joe", "LNAME":"Doe"}. Only available if type is classic. It's considered only if campaign is in _New Template Language format_. The New Template Language is dependent on the values of subject, htmlContent/htmlUrl, sender.name & toField. Example: {"ORDER_ID": "A1001"}
preview_textstring- Preview text or preheader of the email campaign. Example: This month's top picks
recipientsobject- Who to send to: an object with listIds, optional exclusionListIds and segmentIds. Example: {"listIds": [12]}
recurringboolean- FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times. Example: false
reply_tostring- Email on which campaign recipients will be able to reply to. Example: help@example.com
scheduled_atstring- UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). Example: 2026-11-20T09:00:00+01:00
send_at_best_timeboolean- Set this to true if you want to send your campaign at best time. Note:- if true, warmup ip will be disabled. Example: true
senderobject- Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example: {"name":"xyz", "email":"example@abc.com"} {"name":"xyz", "id":123}. Example: {"name": "Acme", "email": "news@example.com"}
subjectstring- Subject of the campaign. Example: November news
tagstring- Tag of the campaign. Example: newsletter
to_fieldstring- To personalize the To Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your Brevo account. If input parameter params used please use {{contact.FNAME}} {{contact.LNAME}} for personalization. Example: {{contact.FIRSTNAME}}
unsubscription_page_idstring- Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page. Example: 62cbb7fabbe85021021aac52
update_form_idstring- Mandatory if templateId is used containing the {{ update_profile }} tag. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form. Example: 6313436b9ba0a5213a7a2d1b
utm_campaignstring- Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed. Example: november-news
utm_contentstring- Customize the utm_content value. Appears on outgoing tracking links alongside utm_campaign. Only alphanumeric characters and spaces are allowed. Example: header-link
utm_idstring- Customize the utm_id value. Appears on outgoing tracking links alongside utm_campaign. When omitted or empty, the utm_id entry from the account's global utm_settings is used if enabled; otherwise no utm_id parameter is emitted. Example: 42
utm_mediumstring- Customize the utm_medium value. When omitted or empty, the utm_medium entry from the account's global utm_settings is used if set; otherwise the default email is used. Example: email
utm_sourcestring- Customize the utm_source value. When omitted or empty, the utm_source entry from the account's global utm_settings is used if set; otherwise the account default (brevo or sendinblue) is used. Example: brevo
utm_termstring- Customize the utm_term value. Appears on outgoing tracking links alongside utm_campaign. Only alphanumeric characters and spaces are allowed. Example: sale
brevo_email_sendSend a transactional email with inline HTML or text, or a Brevo template with params, to one or more recipients; optionally schedule it.WriteSend Transactional Email
Send a transactional email with inline HTML or text, or a Brevo template with params, to one or more recipients; optionally schedule it. Returns messageId (or messageIds for message versions); scheduled sends also return batchId. Use this for transactional email. Use brevo_email_campaign_send_now for a marketing campaign. Prerequisite: the sender must be verified (see brevo_senders_list).
Inputs
attachmentarray- Attachments, each with name and either content (base64) or url (absolute URL of the file) Example: [{"name": "invoice.pdf", "content": "JVBERi0xLjQK"}]
batch_idstring- UUIDv4 identifier for the scheduled batch of transactional emails. If omitted, a valid UUIDv4 batch identifier is automatically generated. Example: 5c6cfa04-eed9-42c2-8b5c-6d470d978e9d
bccarray- Array of BCC recipient objects. Each object contains an email address and an optional name. Example: [{"email": "audit@example.com"}]
ccarray- Array of CC recipient objects. Each object contains an email address and an optional name. Example: [{"email": "boss@example.com"}]
headersobject- Custom email headers (non-standard headers) to include in the email. The sender.ip header can be set to specify the IP address used for sending transactional emails (dedicated IP users only). Header names must use Title-Case-Format (words separated by hyphens with the first letter of each word capitalized). Headers not in this format are automatically converted. Standard email headers are not supported. Example: {"X-Mailin-custom": "order:A1001", "idempotencyKey": "abc-123"}
html_contentstring- HTML body content of the email. Required when templateId is not provided. Ignored when templateId is provided. Example: <html><body><p>Hello {{ contact.FIRSTNAME }}</p></body></html>
message_versionsarray- Array of message version objects for sending customized email variants. The templateId can be customized per version only if a global templateId is provided. The htmlContent and textContent can be customized per version only if at least one of these is present in the global parameters. Global parameters such as to (required), bcc, cc, replyTo, and subject can be customized per version. Example: [{"to": [{"email": "jane@example.com"}], "params": {"NAME": "Jane"}}]
paramsobject- Key-value pairs for template variable substitution. Only applicable when the template uses the New Template Language format. Example: {"ORDER_ID": "A1001"}
reply_to_emailstring- Reply-To address. Example: help@example.com
reply_to_namestring- Reply-To display name. Example: Acme Support
scheduled_atstring- UTC date-time when the email should be sent (format: YYYY-MM-DDTHH:mm:ss.SSSZ). Include timezone information in the date-time value. Scheduled emails may be delayed by up to 5 minutes. Example: 2026-11-20T09:00:00+01:00
sender_emailstring- Sender email address (must be a verified sender or domain). Required unless template_id has a sender. Example: orders@example.com
sender_idinteger- ID of a saved sender, instead of sender_email (see brevo_senders_list) Example: 3
sender_namestring- Sender display name. Example: Acme Orders
subjectstring- Email subject line. Required when templateId is not provided. Example: Your order {{ params.ORDER_ID }} has shipped
tagsarray- Array of tags for categorizing and filtering emails. Example: ["password-reset"]
template_idinteger- Template identifier. Example: 7
text_contentstring- Plain text body content of the email. Ignored when templateId is provided. Example: Hi, your order shipped.
toarray- Recipients, each an object with email and an optional name. Required unless message_versions is set. Example: [{"email": "jane@example.com", "name": "Jane Doe"}]
brevo_email_template_createCreate a transactional email template.WriteCreate Email Template
Create a transactional email template. Returns id of the new template. Send it with brevo_email_send template_id.
Inputs
senderobjectrequired- Sender details including id or email and name (_optional_). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example: {"name":"xyz", "email":"example@abc.com"} {"name":"xyz", "id":123}. Example: {"name": "Acme", "email": "news@example.com"}
subjectstringrequired- Subject of the template. Example: November news
template_namestringrequired- Name of the template. Example: Order shipped
attachment_urlstring- Absolute url of the attachment (no local file). Extension allowed: #### xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps'. Example: https://example.com/terms.pdf
html_contentstring- Body of the message (HTML version). The field must have more than 10 characters. REQUIRED if htmlUrl is empty. Example: <p>Hi {{ params.NAME }}, order {{ params.ORDER_ID }} shipped.</p>
html_urlstring- Url which contents the body of the email message. REQUIRED if htmlContent is empty. Example: https://example.com/template.html
is_activeboolean- Status of template. isActive = true means template is active and isActive = false means template is inactive. Example: true
reply_tostring- Email on which campaign recipients will be able to reply to. Example: help@example.com
tagstring- Tag of the template. Example: password-reset
to_fieldstring- To personalize the To Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your Brevo account. If input parameter params used please use {{contact.FNAME}} {{contact.LNAME}} for personalization. Example: {{contact.FIRSTNAME}} {{contact.LASTNAME}}
brevo_email_template_updateChange an email template's name, subject, sender, HTML, tag or active state.WriteUpdate Email Template
Change an email template's name, subject, sender, HTML, tag or active state. Returns no content (204).
- Idempotent
Inputs
template_idstringrequired- ID of the template. Can be a numeric template ID or a custom template identifier string. Example: 7
attachment_urlstring- Absolute url of the attachment (no local file). Extensions allowed: #### xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps. Example: https://example.com/terms.pdf
html_contentstring- Required if htmlUrl is empty. If the template is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that template. Body of the message (HTML must have more than 10 characters) Example: <html><body><p>Hello {{ contact.FIRSTNAME }}</p></body></html>
html_urlstring- Required if htmlContent is empty. URL to the body of the email (HTML) Example: https://example.com/template.html
is_activeboolean- Status of the template. isActive = false means template is inactive, isActive = true means template is active. Example: true
reply_tostring- Email on which campaign recipients will be able to reply to. Example: help@example.com
senderobject- Sender details including id or email and name (_optional_). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example: {"name":"xyz", "email":"example@abc.com"} {"name":"xyz", "id":123}. Example: {"name": "Acme", "email": "news@example.com"}
subjectstring- Subject of the email. Example: November news
tagstring- Tag of the template. Example: password-reset
template_namestring- Name of the template. Example: Order shipped v2
to_fieldstring- To personalize the To Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your Brevo account. If input parameter params used please use {{contact.FNAME}} {{contact.LNAME}} for personalization. Example: {{contact.FIRSTNAME}}
brevo_event_createTrack a custom event for a contact (for automations and segmentation), creating or updating contact properties.WriteTrack Event
Track a custom event for a contact (for automations and segmentation), creating or updating contact properties. Returns no content (204).
Inputs
event_namestringrequired- The name of the event that occurred. This is how you will find your event in Brevo. Limited to 255 characters; only alphanumeric characters, hyphens (-), and underscores (_) are allowed. Example: order_completed
identifiersobjectrequired- Who the event is about: an object with email_id, phone_id, whatsapp_id, landline_number_id or ext_id. Example: {"email_id": "jane@example.com"}
contact_propertiesobject- Properties defining the state of the contact associated to this event. Useful to update contact attributes defined in your contacts database while passing the event. For example: "FIRSTNAME": "Jane" , "AGE": 37. Example: {"FIRSTNAME": "Jane"}
event_datestring- ISO 8601 timestamp of when the event occurred (e.g. "2024-01-24T17:39:57+01:00"). If no value is passed, the timestamp of the event creation is used. Example: 2026-11-13T10:00:00Z
event_propertiesobject- Properties of the event. Top level properties and nested properties can be used to better segment contacts and personalise workflow conditions. The following field types are supported: string, number, boolean (true/false), date (Timestamp e.g. "2024-01-24T17:39:57+01:00"). Keys are limited to 255 characters, alphanumerical characters and - _ only. Size is limited to 50KB. Example: {"order_id": "A1001", "amount": 59.9}
objectobject- Identifiers of the object record associated with this event. Ignored if the object type or identifier for this record does not exist on the account. Example: {"type": "order", "identifiers": {"id": "A1001"}}
brevo_list_contacts_addAdd existing contacts to a list by email, ID or ext_id (up to 150 per call).WriteAdd Contacts to List
Add existing contacts to a list by email, ID or ext_id (up to 150 per call). Returns contacts with success and failure arrays.
Inputs
list_idintegerrequired- Id of the list. Example: 12
emailsarray- Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. _If you need to add the emails in bulk, please prefer /contacts/import api._. Example: ["jane@example.com"]
ext_idsarray- EXT_ID attributes to add to a list. You can pass a maximum of 150 EXT_ID attributes for addition in one request. _If you need to add the emails in bulk, please prefer /contacts/import api._. Example: ["crm-1001"]
idsarray- IDs to add to a list. You can pass a maximum of 150 IDs for addition in one request. _If you need to add the emails in bulk, please prefer /contacts/import api._. Example: [42]
brevo_list_contacts_removeRemove contacts from a list by email, ID or ext_id, or remove all.WriteRemove Contacts from List
Remove contacts from a list by email, ID or ext_id, or remove all. Returns contacts with success and failure arrays (or a processId when all is true).
Inputs
list_idintegerrequired- Id of the list. Example: 12
allboolean- Required if 'emails', 'extIds' and 'ids' are empty. Remove all existing contacts from a list. A process will be created in this scenario. You can fetch the process details to know about the progress. Example: false
emailsarray- Required if 'all' is false and 'ids', 'extIds' are empty. Emails to remove from a list. You can pass a maximum of 150 emails for removal in one request. Example: ["jane@example.com"]
ext_idsarray- Required if 'all' is false, 'ids' and 'emails' are empty. EXT_ID attributes to remove from a list. You can pass a maximum of 150 EXT_ID attributes for removal in one request. Example: ["crm-1001"]
idsarray- Required if 'all' is false and 'emails', 'extIds' are empty. IDs to remove from a list. You can pass a maximum of 150 IDs for removal in one request. Example: [42]
brevo_list_createCreate a contact list in a folder.WriteCreate Contact List
Create a contact list in a folder. Returns id of the new list.
Inputs
folder_idintegerrequired- Id of the parent folder in which this list is to be created. Example: 1
namestringrequired- Name of the list. Example: VIP customers
brevo_list_updateRename a contact list or move it to another folder.WriteUpdate Contact List
Rename a contact list or move it to another folder. Returns no content (204).
- Idempotent
Inputs
list_idintegerrequired- Id of the list. Example: 12
folder_idinteger- Id of the folder in which the list is to be moved. Either of the two parameters (name, folderId) can be updated at a time. Example: 1
namestring- Name of the list. Either of the two parameters (name, folderId) can be updated at a time. Example: VIP customers 2026
brevo_sender_createCreate an email sender.WriteCreate Sender
Create an email sender. Brevo emails the address a verification code (validate it with the OTP in the Brevo app). Returns id, spfError and dkimError.
Inputs
emailstringrequired- From email to use for the sender. A verification email will be sent to this address. Example: orders@example.com
namestringrequired- From Name to use for the sender. Example: Acme Orders
ipsarray- Mandatory in case of dedicated IP. IPs to associate to the sender. Not required for standard accounts. Example: [{"ip": "123.65.8.22", "domain": "mycompany.com", "weight": 50}]
brevo_sender_updateChange a sender's name, email or dedicated IPs.WriteUpdate Sender
Change a sender's name, email or dedicated IPs. Returns no content (204).
- Idempotent
Inputs
sender_idintegerrequired- Id of the sender. Example: 3
emailstring- From Email to update the sender. Example: orders@example.com
ipsarray- Only in case of dedicated IP. IPs to associate to the sender. If passed, will replace all the existing IPs. Not required for standard accounts. Example: [{"ip": "123.65.8.22", "domain": "mycompany.com", "weight": 50}]
namestring- From Name to update the sender. Example: Acme Orders
brevo_sms_campaign_createCreate an SMS campaign (draft, or scheduled when scheduled_at is set) for contact lists.WriteCreate SMS Campaign
Create an SMS campaign (draft, or scheduled when scheduled_at is set) for contact lists. Returns id of the new campaign.
Inputs
contentstringrequired- Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS. Example: Sale ends tonight: 20% off with code NOV20
namestringrequired- Name of the campaign. Example: November flash sale
senderstringrequired- Name of the sender. The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters. Example: MyShop
organisation_prefixstring- A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms. Example: MyCompany
recipientsobject- Who to send to: an object with listIds and optional exclusionListIds. Example: {"listIds": [12]}
scheduled_atstring- UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. Example: 2026-11-20T09:00:00+01:00
unicode_enabledboolean- Format of the message. It indicates whether the content should be treated as unicode or not. Example: true
unsubscribe_instructionstring- Instructions to unsubscribe from future communications. Recommended by U.S. carriers. Must include STOP keyword. This will be added as instructions after the end of message content. Prefer verifying maximum length of 160 characters including this instructions in message content to avoid multiple sending of same sms. Example: Reply STOP to unsubscribe
brevo_sms_campaign_send_nowSend an SMS campaign to its recipients immediately.WriteSend SMS Campaign Now
Send an SMS campaign to its recipients immediately. Returns no content (204). Spends SMS credits.
Inputs
campaign_idintegerrequired- Id of the campaign. Example: 34
brevo_sms_sendSend a transactional SMS to one mobile number, with inline content or an SMS template.WriteSend Transactional SMS
Send a transactional SMS to one mobile number, with inline content or an SMS template. Returns reference, messageId, smsCount, usedCredits and remainingCredits. Spends SMS credits.
Inputs
recipientstringrequired- Mobile number to send SMS with the country code. Must contain between 6 and 15 digits, optionally prefixed with '+'. Example: +33612345678
senderstringrequired- Sender name: up to 11 letters and digits, or up to 15 digits. Example: MyShop
contentstring- Content of the message. If more than 160 characters long, will be sent as multiple text messages. Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed. Example: Your code is 123456
organisation_prefixstring- A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms. Example: MyCompany
paramsobject- Pass the set of attributes to customize the template. For example, {"FNAME":"Joe", "LNAME":"Doe"}. These are the placeholder variables in the template that will be replaced with the corresponding values passed in the params object. Applicable only if templateId is used. Example: {"CODE": "123456"}
tagstring- Tag of the message. Can be a single string or an array of strings (maximum 10 tags). Each tag must be a non-empty string. Example: otp
template_idinteger- SMS template ID; overrides content. Required unless content is set. Example: 3
typestring- Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc. Example: marketingone of
transactionalmarketing unicode_enabledboolean- Format of the message. It indicates whether the content should be treated as unicode or not. Example: true
web_urlstring- Webhook to call for each event triggered by the message (delivered etc.) Example: https://example.com/brevo/sms-status
brevo_webhook_createCreate a webhook that receives transactional, marketing or inbound events at your URL.WriteCreate Webhook
Create a webhook that receives transactional, marketing or inbound events at your URL. Returns id of the new webhook.
Inputs
urlstringrequired- URL of the webhook. Example: https://example.com/brevo/webhook
authobject- Add authentication on webhook url. Example: {"type": "bearer", "token": "s3cret"}
batchedboolean- To send batched webhooks. Example: true
channelstring- Channel of the webhook. Example: emailone of
emailsms descriptionstring- Description of the webhook. Example: Delivery events
domainstring- Inbound domain of webhook, required in case of event type inbound. Example: inbound.example.com
eventsarray- Events that trigger the webhook. Transactional: sent (or request), delivered, hardBounce, softBounce, blocked, spam, invalid, deferred, click, opened, uniqueOpened, unsubscribed. Marketing: spam, opened, click, hardBounce, softBounce, unsubscribed, listAddition, delivered, contactUpdated, contactDeleted. Inbound: inboundEmailProcessed (the default) Example: ["delivered", "hardBounce", "opened", "click"]
headersarray- Custom headers to be send with webhooks. Example: [{"key": "X-Token", "value": "s3cret"}]
typestring- Type of the webhook. Example: transactionalone of
transactionalmarketinginbound
brevo_webhook_updateChange a webhook's URL, description, events, headers or authentication.WriteUpdate Webhook
Change a webhook's URL, description, events, headers or authentication. Returns no content (204).
- Idempotent
Inputs
webhook_idintegerrequired- Id of the webhook. Example: 56
authobject- Add authentication on webhook url. Example: {"type": "bearer", "token": "s3cret"}
batchedboolean- To send batched webhooks. Example: true
descriptionstring- Description of the webhook. Example: Delivery events
domainstring- Inbound domain of webhook, used in case of event type inbound. Example: inbound.example.com
eventsarray- Events that trigger the webhook. Transactional: sent (or request), delivered, hardBounce, softBounce, blocked, spam, invalid, deferred, click, opened, uniqueOpened, unsubscribed. Marketing: spam, opened, click, hardBounce, softBounce, unsubscribed, listAddition, delivered, contactUpdated, contactDeleted. Inbound: inboundEmailProcessed (the default) Example: ["delivered", "hardBounce", "opened", "click"]
headersarray- Custom headers to be send with webhooks. Example: [{"key": "X-Token", "value": "s3cret"}]
urlstring- URL of the webhook. Example: https://example.com/brevo/webhook
brevo_blocked_contact_unblockUnblock or resubscribe a contact so transactional email can reach it again.DestructiveUnblock Transactional Contact
Unblock or resubscribe a contact so transactional email can reach it again. Returns no content (204).
- Idempotent
Inputs
emailstringrequired- Contact email (urlencoded) to unblock. Example: jane@example.com
brevo_contact_deleteDelete a contact.DestructiveDelete Contact
Delete a contact. Returns no content (204).
- Idempotent
Inputs
identifierstringrequired- Contact identifier: email address, numeric contact ID, ext_id, phone_id, whatsapp_id or landline_number_id (set identifier_type for the non-email kinds) Example: jane@example.com
identifier_typestring- Email_id for Email, contact_id for ID of the contact, ext_id for EXT_ID attribute, phone_id for SMS attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE_NUMBER attribute. Example: email_idone of
email_idcontact_idext_idphone_idwhatsapp_idlandline_number_id
brevo_domain_deleteDelete a sender domain.DestructiveDelete Sender Domain
Delete a sender domain. Returns no content (200/204).
- Idempotent
Inputs
domain_namestringrequired- Domain name. Example: mail.example.com
brevo_email_campaign_deleteDelete an email campaign.DestructiveDelete Email Campaign
Delete an email campaign. Returns no content (204).
- Idempotent
Inputs
campaign_idintegerrequired- Id of the campaign. Example: 34
brevo_email_template_deleteDelete an inactive email template.DestructiveDelete Email Template
Delete an inactive email template. Returns no content (204).
- Idempotent
Inputs
template_idintegerrequired- Id of the template. Example: 7
brevo_list_deleteDelete a contact list.DestructiveDelete Contact List
Delete a contact list. Contacts stay in the account. Returns no content (204).
- Idempotent
Inputs
list_idintegerrequired- Id of the list. Example: 12
brevo_scheduled_email_deleteCancel scheduled transactional emails by batch ID or message ID.DestructiveCancel Scheduled Email
Cancel scheduled transactional emails by batch ID or message ID. Returns no content (204).
- Idempotent
Inputs
identifierstringrequired- batchId of the scheduled batch, or messageId of one scheduled email. Example: 5c6cfa04-eed9-42c2-8b5c-6d470d978e9d
brevo_sender_deleteDelete a sender.DestructiveDelete Sender
Delete a sender. Returns no content (204).
- Idempotent
Inputs
sender_idintegerrequired- Id of the sender. Example: 3
brevo_webhook_deleteDelete a webhook.DestructiveDelete Webhook
Delete a webhook. Returns no content (204).
- Idempotent
Inputs
webhook_idintegerrequired- Id of the webhook. Example: 56
No tools match.