Brevo

Learn how to use Brevo with Composio

Overview

Enum

BREVO

Description

Brevo (formerly Sendinblue) delivers email marketing, SMS campaigns, and marketing automation solutions, empowering businesses to nurture leads, engage audiences, and drive conversions

Authentication Details

host
stringDefaults to https://api.brevo.com/v3/
api_key
stringRequired

Actions

Endpoint /crm/notes/{id}“ allows deleting a specific note by its id. it returns a 204 status code when successful, or a 400/404 with error details if the request fails. essential for managing crm notes efficiently.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Deletes a contact list by its id. returns a 204 response if successful, or errors such as 400 (bad request) and 404 (list id not found) with detailed codes and messages for failure reasons.

Action Parameters

listId
integerRequired

Action Response

data
object
successful
boolean
error

This endpoint enables resellers to delete domains for a child account using the child’s id and domain name, ensuring secure removal by managing potential errors and unauthorized access.

Action Parameters

childIdentifier
stringRequired
domainName
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint allows you to list all groups created on your admin account.

Action Parameters

Action Response

data
object
successful
boolean
error

This endpoint fetches a filtered task list based on type, status, assignee, contacts, deals, and company ids within a date range. it offers pagination, sorting, and outputs tasks’ details including ids, names, and linked entities.

Action Parameters

filter__type
string
filter__status
string
filter__date
string
filter__assignTo
string
filter__contacts
string
filter__deals
string
filter__companies
string
dateFrom
integer
dateTo
integer
offset
integer
limit
integerDefaults to 50
sort
string
sortBy
string

Action Response

data
object
successful
boolean
error

This endpoint will show the list of emails for past 30 days by default. to retrieve emails before that time, please pass startdate and enddate in query filters.

Action Parameters

email
string
templateId
integer
messageId
string
startDate
string
endDate
string
sort
stringDefaults to desc
limit
integerDefaults to 500
offset
integer

Action Response

data
object
successful
boolean
error

This ecommerce endpoint allows fetching product details by id, including its name, dates, images, and metadata. it supports get requests, and provides error codes and messages for issues like bad requests or missing product ids.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint will update an external feed.

Action Parameters

uuid
stringRequired

Action Response

data
object
successful
boolean
error

Get the list of blocked domains

Action Parameters

Action Response

data
object
successful
boolean
error

This endpoint allows resellers to check if a child account has been successfully created by providing the child’s identifier. it returns a boolean status and handles errors such as bad requests or unauthorized access.

Action Parameters

childIdentifier
stringRequired

Action Response

data
object
successful
boolean
error

Retrieve company details by id. provides company attributes, linked contacts & deals. errors for invalid id or missing company.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint updates a reseller’s child profile using their identifier, allowing changes to email, names, company, and password. it handles incorrect inputs or unauthorized actions with detailed error messages.

Action Parameters

childIdentifier
stringRequired
email
string
firstName
string
lastName
string
companyName
string
password
string

Action Response

data
object
successful
boolean
error

This endpoint allows to create a group of sub-accounts

Action Parameters

groupName
stringRequired
subAccountIds
array

Action Response

data
object
successful
boolean
error

Update email campaign status (suspended, archive, etc.) using its id. requires id in path, new status in json. successful updates return 204, 400 for bad requests, 404 if id not found.

Action Parameters

campaignId
integerRequired
status
string

Action Response

data
object
successful
boolean
error

Blocks a new domain in order to avoid messages being sent to the same

Action Parameters

domain
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint enables sending an sms campaign instantly via post to ‘/smscampaigns/{campaignid}/sendnow’, needing a campaignid. it returns 204 for success, and errors 400, 402, or 404 for various failures.

Action Parameters

campaignId
integerRequired

Action Response

data
object
successful
boolean
error

Obtain winning version of an a/b test email campaign

Action Parameters

campaignId
integerRequired

Action Response

data
object
successful
boolean
error

To unblock a transactional email contact, send a delete request to /smtp/blockedcontacts/{email}“ with their email in the url. possible responses are 204 (unblocked), 400 (bad request), and 404 (email not found).

Action Parameters

email
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint updates email campaign details, including tags, content, schedule, and sender info. features a/b testing, ip warmup, and metrics. it also handles errors for invalid inputs or missing ids.

Action Parameters

campaignId
integerRequired
tag
string
sender__name
string
sender__email
string
sender__id
integer
name
string
htmlContent
string
htmlUrl
string
scheduledAt
string
subject
string
previewText
string
replyTo
string
toField
string
recipients__exclusionListIds
array
recipients__listIds
array
recipients__segmentIds
array
attachmentUrl
string
inlineImageActivation
boolean
mirrorActive
boolean
recurring
boolean
footer
string
header
string
utmCampaign
string
params
object
sendAtBestTime
boolean
abTesting
boolean
subjectA
string
subjectB
string
splitRule
integer
winnerCriteria
string
winnerDelay
integer
ipWarmupEnable
boolean
initialQuota
integer
increaseRate
integer
unsubscriptionPageId
string
updateFormId
string

Action Response

data
object
successful
boolean
error

Retrieve comprehensive reports for email campaigns by supplying the campaign id and optional stat filters, covering everything from global stats and link analytics to recipient interactions.

Action Parameters

campaignId
integerRequired
statistics
string

Action Response

data
object
successful
boolean
error

This ecommerce api allows for detailed product searches with filters (e.g., price, categories), and supports pagination. it offers thorough product information, including images and metadata.

Action Parameters

limit
integerDefaults to 50
offset
integer
sort
stringDefaults to desc
ids
array
name
string
price__lte
integer
price__gte
integer
price__lt
integer
price__gt
integer
price__eq
integer
price__ne
integer
categories
array
modifiedSince
string
createdSince
string

Action Response

data
object
successful
boolean
error

The put endpoint /contacts/folders/{folderid}“ updates a contact folder’s name using its id and a json payload. it returns 204 on success, 400 for bad requests, and 404 if the id is not found.

Action Parameters

folderId
integerRequired
name
string

Action Response

data
object
successful
boolean
error

Update a message by its id by sending the new text in json format. successful updates show the updated message details; failures return error codes and messages.

Action Parameters

id
stringRequired
text
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint will generate an api v3 key for a sub account

Action Parameters

id
integerRequired
name
stringRequired

Action Response

data
object
successful
boolean
error

The endpoint fetches all contact lists, supporting pagination (via limit and offset), sorting (by creation time), and filtering. it returns details like ids, names, subscriber counts, and folder ids.

Action Parameters

limit
integerDefaults to 10
offset
integer
sort
stringDefaults to desc

Action Response

data
object
successful
boolean
error

This endpoint allows for the partial update of a company’s details by its id. it requires a json body with company details, such as name and attributes, and responds with updated company information. errors are returned for invalid data or not found ids.

Action Parameters

id
stringRequired
name
string
countryCode
integer

Action Response

data
object
successful
boolean
error

Create and manage whatsapp campaigns by specifying details like name, template id, schedule, and recipients. essential fields include template id and recipient info. it generates success confirmation or detailed errors.

Action Parameters

name
stringRequired
templateId
integerRequired
scheduledAt
stringRequired
recipients__excludedListIds
array
recipients__listIds
array
recipients__segments
array

Action Response

data
object
successful
boolean
error

Update a webhook by including its id in the path and updating details in the request body like description, url, and more. successful updates return 204, while invalid requests return 400, and missing webhook ids return 404.

Action Parameters

webhookId
integerRequired
description
string
url
string
events
array
domain
string
batched
boolean
headers
array

Action Response

data
object
successful
boolean
error

Create an event to track a contact’s interaction.

Action Parameters

event_name
stringRequired
event_date
string
identifiers__email__id
string
contact_properties
object
event_properties
object

Action Response

data
object
successful
boolean
error

Brevo provides features like email campaigns, deals, and calls with customizable user access levels, including creation and editing. ensure to specify the appropriate permission level for each user based on your plan for an optimal experience.

Action Parameters

email
stringRequired
all_features_access
booleanRequired
privileges
arrayRequired

Action Response

data
object
successful
boolean
error

This endpoint deletes a specified task by its id. success returns 204 with no content. errors yield a 400 for invalid requests, detailing the issue, or a 404 if the task id isn’t found, with specific error messages and codes provided for clarity.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint retrieves all task types, returning their ids and titles in json format. it’s tagged under “tasks” with a successful response indicating the detailed task types available.

Action Parameters

Action Response

data
object
successful
boolean
error

The /crm/notes/{id}“ endpoint supports get requests to fetch details of a specific note by id, including text, linked contacts, deals, author information, and timestamps, with responses for successful retrieval, invalid data, or note not found.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Retrieve a list of contacts blocked or unsubscribed from transactional emails within a specified date range. supports pagination, sender filtering, and sorting.

Action Parameters

startDate
string
endDate
string
limit
integerDefaults to 50
offset
integer
senders
array
sort
stringDefaults to desc

Action Response

data
object
successful
boolean
error

Delete scheduled batch of emails by batchid or single scheduled email by messageid

Action Parameters

identifier
stringRequired

Action Response

data
object
successful
boolean
error

Api endpoints for the corporate owner to enable/disable applications on the sub-account

Action Parameters

id
integerRequired
inbox
boolean
whatsapp
boolean
automation
boolean
email__campaigns
boolean
sms__campaigns
boolean
landing__pages
boolean
transactional__emails
boolean
transactional__sms
boolean
facebook__ads
boolean
web__push
boolean
meetings
boolean
conversations
boolean
crm
boolean

Action Response

data
object
successful
boolean
error

This endpoint enables agents to send messages in conversations using a json with visitorid and text required, and optional fields like agentid. success returns message details; failures return error codes.

Action Parameters

visitorId
Required
text
Required
agentId
receivedFrom
agentEmail
agentName

Action Response

data
object
successful
boolean
error

The endpoint enables creating custom transactional email templates with details like sender, subject, content, etc. successful creations yield a 201 status and template id; failures return errors and codes.

Action Parameters

tag
string
sender__name
string
sender__email
string
sender__id
integer
templateName
stringRequired
htmlContent
string
htmlUrl
string
subject
stringRequired
replyTo
string
toField
string
attachmentUrl
string
isActive
boolean

Action Response

data
object
successful
boolean
error

This endpoint fetches details of a whatsapp campaign by id, including its name, status, sender, recipients, template, and dates, plus error messages for invalid or absent campaigns.

Action Parameters

campaignId
integerRequired

Action Response

data
object
successful
boolean
error

Update contact lists by id. accepts renaming the list or moving it to a different folder. requires listid in the path and json body with name or folderid. returns 204 on success or specific error codes for failures such as 400 and 404.

Action Parameters

listId
integerRequired
name
string
folderId
integer

Action Response

data
object
successful
boolean
error

Deletes a specified whatsapp campaign by campaignid. on success, returns a 204 status with no content. errors lead to a 400 or 404 response, detailing the issue with error codes and messages.

Action Parameters

campaignId
integerRequired

Action Response

data
object
successful
boolean
error

This endpoint lets resellers remove a dedicated ip from a child account by providing the child’s identifier and the ip address. a successful removal returns a 204 status, with failures giving 400 or 404 errors based on the issue.

Action Parameters

childIdentifier
stringRequired
ip
string

Action Response

data
object
successful
boolean
error

This endpoint enables whatsapp campaign template creation, requiring name, language, category, and bodytext. mediaurl and headertext are optional. success returns a 201 status and template id; failures return error details.

Action Parameters

name
stringRequired
language
stringRequired
category
stringRequired
mediaUrl
string
bodyText
stringRequired
headerText
string
source
string

Action Response

data
object
successful
boolean
error

This post endpoint lets resellers add email/sms credits to a child account using ‘childidentifier’. it needs json input for the credit amount. successful requests update both child and reseller credit balances, with error handling via specific codes.

Action Parameters

childIdentifier
stringRequired
sms
integer
email
integer

Action Response

data
object
successful
boolean
error

This endpoint will delete an external feed.

Action Parameters

uuid
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint retrieves a list of company attributes, including names, labels, types, options, and required status in json format. suitable for understanding company data structure.

Action Parameters

Action Response

data
object
successful
boolean
error

This get endpoint fetches details about a contact list using its listid, including id, name, subscribers, blacklisted contacts, and email campaign stats with optional date range. it returns list details, error messages, or a 404 error if not found.

Action Parameters

listId
integerRequired
startDate
string
endDate
string

Action Response

data
object
successful
boolean
error

Example of automated messages: order status, announce new features in your web app, etc.

Action Parameters

visitorId
Required
text
Required
agentId
groupId

Action Response

data
object
successful
boolean
error

This endpoint fetches detailed file information by id, including name, authorid, and more. responses vary from successful retrieval (200) to invalid data (400) and not found (404).

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint provides daily reports on email activities like requests, deliveries, and clicks, with filters by date or tags, and sorting options. it also supports pagination with customizable settings.

Action Parameters

limit
integerDefaults to 10
offset
integer
startDate
string
endDate
string
days
integer
tag
string
sort
stringDefaults to desc

Action Response

data
object
successful
boolean
error

This endpoint allows adding existing contacts to a specific list by its id. users can add contacts through their email addresses or ids, with a max limit of 150 per request. successful additions and failures are reported in the response.

Action Parameters

listId
integerRequired

Action Response

data
object
successful
boolean
error

This endpoint lets users resend or cancel an email invitation by specifying the action and user email, providing success confirmation or unauthorized access errors.

Action Parameters

action
stringRequired
email
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint enables users to create notes in the crm with text and linked ids (contact, deal, company), returning the note’s id or errors for invalid inputs/formats.

Action Parameters

text
stringRequired
contactIds
array
dealIds
array
companyIds
array

Action Response

data
object
successful
boolean
error

The get endpoint ‘/contacts/segments’ retrieves segments, allowing filtering, pagination via ‘limit’ and ‘offset’, and sorting with ‘sort’. it returns listings including id, name, category, and last update time.

Action Parameters

limit
integerDefaults to 10
offset
integer
sort
stringDefaults to desc

Action Response

data
object
successful
boolean
error

This endpoint allows for the deletion of a specified deal by its id. upon successful deletion, a 204 status is returned. errors are detailed with specific codes and messages for issues like invalid data (400) or missing ids (404).

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

The get /crm/deals endpoint fetches a list of deals with optional filters (name, company, contact ids), supporting pagination (offset, limit) and sort order, returning deal details and linked entities.

Action Parameters

filters__attributes__deal__name
string
filters__linkedCompaniesIds
string
filters__linkedContactsIds
string
offset
integer
limit
integer
sort
string

Action Response

data
object
successful
boolean
error

This endpoint retrieves detailed sms event stats, allowing for pagination, date range, and phone number/event type/tag filtering. it includes specifics like message id and bounce reasons, with error handling.

Action Parameters

limit
integerDefaults to 50
startDate
string
endDate
string
offset
integer
days
integer
phoneNumber
string
event
string
tags
string
sort
stringDefaults to desc

Action Response

data
object
successful
boolean
error

Endpoint allows sending a test sms for a specific campaign by id. requires the recipient’s mobile number in json format. responds with success or error detailing issues like invalid parameters or campaign id not found.

Action Parameters

campaignId
integerRequired
phoneNumber
string

Action Response

data
object
successful
boolean
error

This endpoint retrieves a list of email templates, allowing filtering by status, pagination through limit and offset parameters, and sorting by creation order. supports querying active/inactive templates and customization on returned results.

Action Parameters

templateStatus
boolean
limit
integerDefaults to 50
offset
integer
sort
stringDefaults to desc

Action Response

data
object
successful
boolean
error

This endpoint updates a deal’s details using its id, requiring a path ‘id’ parameter and a json body with the information. success returns a 204 code; errors have specific codes/messages for invalid data or missing id.

Action Parameters

id
stringRequired
name
string

Action Response

data
object
successful
boolean
error

The /contacts/batch post endpoint enables bulk contact updates, including emails, sms, external ids, and more. it requires a structured object with identifiers and update values. responses indicate success (204) or error (400) with messages.

Action Parameters

contacts
array

Action Response

data
object
successful
boolean
error

Update a reseller’s child sender domain by specifying childidentifier and domainname. requires the new domain value in the request. supports error handling for invalid requests and permissions.

Action Parameters

childIdentifier
stringRequired
domainName
stringRequired
domain
string

Action Response

data
object
successful
boolean
error

Retrieve process details by id, including its name, status, and export url upon completion. supports querying with the process id and returns response codes for success (200), bad request (400), or not found (404).

Action Parameters

processId
integerRequired

Action Response

data
object
successful
boolean
error

The put endpoint ‘/senders/domains/{domainname}/authenticate’ authenticates domain names, returning success with details or errors for bad requests or non-existent domains.

Action Parameters

domainName
stringRequired

Action Response

data
object
successful
boolean
error

Endpoint updates sms campaign status via put; include campaign id, desired status in body. supports various statuses; successful updates return 204, errors may return 400 or 404.

Action Parameters

campaignId
integerRequired
status
string

Action Response

data
object
successful
boolean
error

Delete a specific attribute from a contact by specifying its category and name. categories include normal, transactional, etc. successful deletion returns a 204 status. errors return relevant codes such as ‘bad request’ or ‘attribute not found’.

Action Parameters

attributeCategory
stringRequired
attributeName
stringRequired

Action Response

data
object
successful
boolean
error

The ‘/coupons’ post endpoint enables coupon creation in collections, requiring ‘collectionid’ (uuidv4) and ‘coupons’ array. it returns 204, 400, 401, 404 statuses based on the request’s nature.

Action Parameters

collectionId
stringRequired
coupons
arrayRequired

Action Response

data
object
successful
boolean
error

Access whatsapp api account details including business id, sending limits, and phone number quality. view account, phone number, and business verification statuses. handle errors with specific codes and messages.

Action Parameters

Action Response

data
object
successful
boolean
error

Fetch a specific coupon collection’s details by id, including name, creation date, and coupon metrics. returns errors for bad requests, unauthorized access, or if not found.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint enables the creation of a contact through the double opt-in (doi) process. it requires the contact’s email, template id, redirection url, and list ids for inclusion. responses indicate contact creation, update, or errors.

Action Parameters

email
stringRequired
attributes
object
includeListIds
arrayRequired
excludeListIds
array
templateId
integerRequired
redirectionUrl
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint enables resellers to fetch child account details using an auth key or id, offering data on company info, credits, email/sms usage, and tech specifics such as ips and api keys. it also details responses for invalid or unauthorized requests.

Action Parameters

childIdentifier
stringRequired

Action Response

data
object
successful
boolean
error

Getting access to brevo ecommerce.

Action Parameters

Action Response

data
object
successful
boolean
error

This endpoint creates reseller child accounts requiring company info, email, and password in json. it returns a 201 status, authkey, and id on success, or 400/403 errors for bad requests or insufficient permissions.

Action Parameters

email
stringRequired
firstName
stringRequired
lastName
stringRequired
companyName
stringRequired
password
stringRequired
language
string

Action Response

data
object
successful
boolean
error

To create an sms campaign, define details like name, sender, message, recipients, and schedule. messages must comply with length limits and have opt-out info. success or error codes indicate campaign status.

Action Parameters

name
stringRequired
sender
stringRequired
content
stringRequired
recipients__listIds
array
recipients__exclusionListIds
array
scheduledAt
string
unicodeEnabled
boolean
organisationPrefix
string
unsubscribeInstruction
string

Action Response

data
object
successful
boolean
error

This endpoint will provide the details for the specified sub-account company

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

This endpoint allows you to retrieve a specific group’s information such as the list of sub-organizations and the user associated with the group.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

The /senders/domains endpoint provides a complete list of domains linked to your account, detailing each domain’s id, name, auth status, verification status, and any dedicated ips, along with property details and error information for invalid requests.

Action Parameters

Action Response

data
object
successful
boolean
error

This api endpoint fetches contact folders with pagination and optional sorting. it supports page size, index, and sorting direction, defaulting values if unspecified. it returns folder id, name, and contact counts, handling errors like bad requests.

Action Parameters

limit
integerRequired
offset
integerRequired
sort
stringDefaults to desc

Action Response

data
object
successful
boolean
error

This api endpoint checks a domain’s verification, authentication, and dns records by requiring a domainname. it returns the domain’s statuses and records on success, or error messages on failure.

Action Parameters

domainName
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint sends an email campaign instantly via post, requiring a campaignid in the path. responses include success (204), invalid request errors (400), insufficient credits (402), and invalid campaign id errors (404).

Action Parameters

campaignId
integerRequired

Action Response

data
object
successful
boolean
error

Create a coupon collection by sending json with ‘name’ and ‘defaultcoupon’. success returns the new collection’s uuid. errors detailed for bad requests and unauthorized access.

Action Parameters

name
stringRequired
defaultCoupon
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint retrieves a list of companies with optional filters, supports pagination, sorting, and limits, includes company details in responses, and provides error specifics.

Action Parameters

filters
string
linkedContactsIds
integer
linkedDealsIds
string
page
integer
limit
integer
sort
string
sortBy
string

Action Response

data
object
successful
boolean
error

This endpoint fetches created whatsapp template messages, offering filters like dates, pagination, and sorting. parameters: startdate, enddate, limit, offset, sort, source. it returns details such as id, name, status, and creation date.

Action Parameters

startDate
string
endDate
string
limit
integerDefaults to 50
offset
integer
sort
stringDefaults to desc
source
string

Action Response

data
object
successful
boolean
error

This endpoint will show the list of all the events for the received emails.

Action Parameters

sender
string
startDate
string
endDate
string
limit
integerDefaults to 100
offset
integer
sort
stringDefaults to desc

Action Response

data
object
successful
boolean
error

This endpoint generates an sso token to authenticate and access the admin account using the endpoint https://account-app.brevo.com/account/login/corporate/sso/[token], where [token] will be replaced by the actual token.

Action Parameters

email
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint fetches an automated message by id, detailing its id, type, text, sender, and creation time, and includes error codes for invalid data or not found items.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

The /smtp/templates/{templateid}/sendtest endpoint sends a template email to a test list or specified addresses, with templateid and optional emailto. max 50 emails/day. responses: 204 (success), 400 (bad request), 404 (id not found).

Action Parameters

templateId
integerRequired
emailTo
array

Action Response

data
object
successful
boolean
error

Delete an inactive email template by its id. supports error responses for bad requests and cases where the template id is not found.

Action Parameters

templateId
integerRequired

Action Response

data
object
successful
boolean
error

Fetch email template details by templateid for transactional emails, including name, subject, status, content, and more. supports fetching by template id with a path parameter. responses include success and error cases.

Action Parameters

templateId
integerRequired

Action Response

data
object
successful
boolean
error

This endpoint is used to send a whatsapp message. (the first message you send using the api must contain a template id. you must create a template on whatsapp on the brevo platform to fetch the template id.)

Action Parameters

Action Response

data
object
successful
boolean
error

This api endpoint fetches all account processes, enabling result customization (limit, offset, sort) and showing process ids, names, statuses, and export urls. it supports pagination and sorting.

Action Parameters

limit
integerDefaults to 10
offset
integer
sort
stringDefaults to desc

Action Response

data
object
successful
boolean
error

This endpoint will provide the details of the master account.

Action Parameters

Action Response

data
object
successful
boolean
error

This endpoint updates an sms campaign by id, allowing modifications to its name, sender, content, recipient lists, schedule, and more. success returns a 204 status; errors yield 400 or 404 with details.

Action Parameters

campaignId
integerRequired
name
string
sender
string
content
string
recipients__listIds
array
recipients__exclusionListIds
array
scheduledAt
string
unicodeEnabled
boolean
organisationPrefix
string
unsubscribeInstruction
string

Action Response

data
object
successful
boolean
error

Export email campaign recipients by post to ‘/emailcampaigns/{campaignid}/exportrecipients’ with the id and recipient type (e.g., ‘openers’, ‘clickers’) in the body. an optional webhook url for notifications can be included.

Action Parameters

campaignId
integerRequired
notifyURL
string
recipientsType
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint allows to revoke/remove an invited member of your admin account

Action Parameters

email
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint deletes an automated message by its id, responds with 204 if successful, and provides error codes 400 or 404 with details if it fails.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint will allow the user to: - resend an admin user invitation - cancel an admin user invitation

Action Parameters

action
stringRequired
email
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint enables resellers to deduct email/sms credits from a child account using childidentifier. requests must specify credit amounts. responses may confirm removal or report errors such as unauthorized access or account not found.

Action Parameters

childIdentifier
stringRequired
sms
integer
email
integer

Action Response

data
object
successful
boolean
error

This endpoint allows you to list all admin users of your admin account

Action Parameters

Action Response

data
object
successful
boolean
error

It returns the background process id which on completion calls the notify url that you have set in the input.

Action Parameters

campaignId
integerRequired
notifyURL
string
recipientsType
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint will show the unaggregated statistics for whatsapp activity (30 days by default if startdate and enddate or days is not passed. the date range can not exceed 90 days)

Action Parameters

limit
integerDefaults to 2500
offset
integer
startDate
string
endDate
string
days
integer
contactNumber
string
event
string
sort
stringDefaults to desc

Action Response

data
object
successful
boolean
error

This endpoint allows you to remove a sub-organization from a group.

Action Parameters

groupId
stringRequired
subAccountIds
arrayRequired

Action Response

data
object
successful
boolean
error

Unblocks an existing domain from the list of blocked domains

Action Parameters

domain
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint enables batch creation and optional update of e-commerce categories via json, requiring unique ids for each. it reports counts of new and updated categories or provides error details on failures.

Action Parameters

categories
arrayRequired
updateEnabled
boolean

Action Response

data
object
successful
boolean
error

This api endpoint updates a contact attribute, requiring its category and name. it accepts a new value or values with labels in the request, responding with 204 for success, or error codes like 400/404 for invalid requests or not found attributes.

Action Parameters

attributeCategory
stringRequired
attributeName
stringRequired
value
string
enumeration
array

Action Response

data
object
successful
boolean
error

Get all the orders

Action Parameters

limit
integerDefaults to 50
offset
integer
sort
stringDefaults to desc
modifiedSince
string
createdSince
string

Action Response

data
object
successful
boolean
error

This endpoint updates a contact’s details, including attributes and blacklist statuses, using either an id or email. it accepts a json body and returns codes for success (204), bad request (400), or not found (404).

Action Parameters

identifier
stringRequired
attributes
object
ext_id
string
emailBlacklisted
boolean
smsBlacklisted
boolean
listIds
array
unlinkListIds
array
smtpBlacklistSender
array

Action Response

data
object
successful
boolean
error

Send report of sent and archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail.

Action Parameters

campaignId
integerRequired
language
stringDefaults to fr
email__to
array
email__body
string

Action Response

data
object
successful
boolean
error

This ecommerce endpoint retrieves details of a specific category by id, including its name, creation and modification timestamps, and url. responses include successful details retrieval, bad request errors, and not found errors for invalid ids.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint sends whatsapp campaign templates for approval, requiring a template id. a successful submission returns a 200 status; errors return specific codes and messages for issues like bad requests or unauthorized access.

Action Parameters

templateId
integerRequired

Action Response

data
object
successful
boolean
error

This endpoint enables creating contact attributes in various categories by specifying an attribute name and category, accepting json objects with attribute details. success returns a 201 status; failures return an error message.

Action Parameters

attributeCategory
stringRequired
attributeName
stringRequired
value
string
isRecurring
boolean
enumeration
array
type
string

Action Response

data
object
successful
boolean
error

Retrieve details of a specific webhook by its id, including events it’s configured for, type (marketing/transactional), creation/modification dates, url, description, and more. supports error handling for bad requests and unfound ids.

Action Parameters

webhookId
integerRequired

Action Response

data
object
successful
boolean
error

Fetch scheduled batch of emails by batchid or single scheduled email by messageid (can retrieve data upto 30 days old)

Action Parameters

identifier
stringRequired
startDate
string
endDate
string
sort
stringDefaults to desc
status
string
limit
integerDefaults to 100
offset
integer

Action Response

data
object
successful
boolean
error

The /categories endpoint supports pagination, sorting, and filtering for retrieving categories. it provides details like id, name, urls, and timestamps along with the total count, and handles errors for invalid requests.

Action Parameters

limit
integerDefaults to 50
offset
integer
sort
stringDefaults to desc
ids
array
name
string
modifiedSince
string
createdSince
string

Action Response

data
object
successful
boolean
error

This endpoint deletes smtp logs using a message id or email, confirms with a 204 status, and gives error details for issues like bad requests or missing message ids.

Action Parameters

identifier
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint will show the list of all events history for one particular received email.

Action Parameters

uuid
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint (/crm/attributes/deals) fetches deal attributes, returning an array of attribute details including internal name, label, type, options, and if required.

Action Parameters

Action Response

data
object
successful
boolean
error

Delete hardbounces. to use carefully (e.g. in case of temporary isp failures)

Action Parameters

startDate
string
endDate
string
contactEmail
string

Action Response

data
object
successful
boolean
error

This endpoint (/crm/pipeline/details/all) retrieves all pipeline details, including names, ids, and stages. it returns an array of pipeline objects on success or error codes for invalid requests.

Action Parameters

Action Response

data
object
successful
boolean
error

This api endpoint enables creating a company with details (name, attributes, country code) in json. it returns a unique id upon success, and specific error codes and messages for issues like invalid data.

Action Parameters

name
stringRequired
countryCode
integer

Action Response

data
object
successful
boolean
error

This endpoint invites members to manage the admin account. it details permissions for features like my plan, api (none), user management, and app management (not in entv2), with a note on conditional access based on the ‘all features access’ flag.

Action Parameters

email
stringRequired
all_features_access
booleanRequired
groupIds
array
privileges
arrayRequired

Action Response

data
object
successful
boolean
error

This endpoint will update an external feed.

Action Parameters

uuid
stringRequired
name
string
url
string
authType
string
username
string
password
string
token
string
headers
array
maxRetries
integerDefaults to 5
cache
boolean

Action Response

data
object
successful
boolean
error

This endpoint allows for the deletion of an sms campaign by campaignid. it responds with a 204 code on successful deletion, and error codes (400 or 404) for failures like invalid request or campaign id not found.

Action Parameters

campaignId
integerRequired

Action Response

data
object
successful
boolean
error

This endpoint updates a note by id, allowing changes to text, contacts, deals, and companies. it requires a json body with text and optional linked ids. on success, it returns http 204, and for errors, returns 400, 404, or 415.

Action Parameters

id
stringRequired
text
stringRequired
contactIds
array
dealIds
array
companyIds
array

Action Response

data
object
successful
boolean
error

Retrieve a list of dedicated ip addresses for your account, including ip details such as id, ip address, status (active/inactive), and associated domain.

Action Parameters

Action Response

data
object
successful
boolean
error

To assign a dedicated ip to a reseller’s child account, send a post request to /reseller/children/{childidentifier}/ips/associate with the child’s id and ip address. possible responses: 204 (success), 400 (bad request), 404 (child not found).

Action Parameters

childIdentifier
stringRequired
ip
string

Action Response

data
object
successful
boolean
error

This endpoint allows downloading a file by id. specify id in the path to request a file. successful requests return a temporary link to download the file, valid for 5 minutes. responses may include errors for invalid data or if the file is not found.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint fetches email campaigns based on filters like type, status, and stats. it allows queries by date, supports pagination, and sorting, returning comprehensive details on campaigns, their statistics, and recipient information.

Action Parameters

type
string
status
string
statistics
string
startDate
string
endDate
string
limit
integerDefaults to 50
offset
integer
sort
stringDefaults to desc
excludeHtmlContent
boolean

Action Response

data
object
successful
boolean
error

Create multiple orders at one time instead of one order at a time

Action Parameters

orders
arrayRequired
notifyUrl
string
historical
booleanDefaults to True

Action Response

data
object
successful
boolean
error

Delete a contact using an id or email via ‘identifier.’ successful deletions return 204; failures may yield 400, 404, or 405 errors if attempting to delete a registered email.

Action Parameters

identifier
stringRequired

Action Response

data
object
successful
boolean
error

The /couponcollections endpoint provides access to all coupon collections, supporting pagination, sorting by creation date, and includes important details like id, name, default coupon, creation and expiry dates, and coupon counts.

Action Parameters

limit
integerDefaults to 50
offset
integer
sort
stringDefaults to desc

Action Response

data
object
successful
boolean
error

Fetch all verified sender domains for a specific reseller’s child account by providing the child’s identifier. returns domain status and examples of successful calls. handles errors for bad requests, unauthorized access, and resource not found.

Action Parameters

childIdentifier
stringRequired

Action Response

data
object
successful
boolean
error

Only agents’ messages can be deleted.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint will create an external feed.

Action Parameters

name
stringRequired
url
stringRequired
authType
stringDefaults to noAuth
username
string
password
string
token
string
headers
array
maxRetries
integerDefaults to 5
cache
boolean

Action Response

data
object
successful
boolean
error

Delete a reseller’s child account using their identifier. requires the child’s id or auth key. success or failure responses include status codes 204 (deleted), 400 (bad request), 403 (unauthorized), or 404 (not found).

Action Parameters

childIdentifier
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint is deprecated. prefer /crm/pipeline/details/{pipelineid} instead.

Action Parameters

Action Response

data
object
successful
boolean
error

The post /senders endpoint creates new senders with name, email (requires verification), and optional dedicated ips (with domain and weight). returns sender id, spf, dkim statuses, or error codes/messages.

Action Parameters

name
stringRequired
email
stringRequired
ips
array

Action Response

data
object
successful
boolean
error

This endpoint fetches details of a specific contacts folder including id, name, and subscriber counts based on the provided foldergb input. it returns folder details or errors for bad requests or when the folder id isn’t found.

Action Parameters

folderId
integerRequired

Action Response

data
object
successful
boolean
error

This endpoint will create a new sub-account under a master account

Action Parameters

companyName
stringRequired
email
stringRequired
language
string
timezone
string

Action Response

data
object
successful
boolean
error

Delete a company by id. requires the company id in the path. success results in a 204 status, while errors return 400 (invalid data) or 404 (not found) with detailed error messages.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Fetches email campaign stats for a contact by email/id with optional date filters (max 90 days), including sent messages, deliveries, opens, clicks, bounces, complaints, and unsubscribes.

Action Parameters

identifier
stringRequired
startDate
string
endDate
string

Action Response

data
object
successful
boolean
error

It returns the background process id which on completion calls the notify url that you have set in the input. note: - any contact attribute that doesn’t exist in your account will be ignored at import end.

Action Parameters

fileUrl
string
fileBody
string
jsonBody
array
listIds
array
notifyUrl
string
newList__listName
string
newList__folderId
integer
emailBlacklist
boolean
disableNotification
boolean
smsBlacklist
boolean
updateExistingContacts
booleanDefaults to True
emptyContactsAttributes
boolean

Action Response

data
object
successful
boolean
error

This endpoint delivers detailed sms campaign data, including the ability to filter by status, date, and sort. it supports queries for various parameters, offering insights into content, scheduling, sender, recipients, and performance metrics.

Action Parameters

status
string
startDate
string
endDate
string
limit
integerDefaults to 500
offset
integer
sort
stringDefaults to desc

Action Response

data
object
successful
boolean
error

Fetches a specific message in a conversation by its id. supports detailed object including message id, type (agent/visitor), text, agent and visitor info, timestamps, and file attachments if any. errors for invalid requests or missing items are detailed.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint deletes a contact folder and its lists using a folderid. success results in a 204 status, while errors return 400 or 404 with details.

Action Parameters

folderId
integerRequired

Action Response

data
object
successful
boolean
error

This endpoint sends test email campaigns, specified by campaignid, to up to 50 recipients daily. it returns a 204 code for success and provides detailed messages for failures due to invalid emails or limit breaches.

Action Parameters

campaignId
integerRequired
emailTo
array

Action Response

data
object
successful
boolean
error

This endpoint lets users send or schedule transactional emails with customizable sender details, recipients, content, attachments, and headers. it supports tags and templates for management and personalization.

Action Parameters

tags
array
sender__name
string
sender__email
string
sender__id
integer
to
array
bcc
array
cc
array
htmlContent
string
textContent
string
subject
string
replyTo__email
string
replyTo__name
string
attachment
array
headers
object
templateId
integer
params
object
messageVersions
array
scheduledAt
string
batchId
string

Action Response

data
object
successful
boolean
error

This endpoint fetches permissions for a user based on email, detailing their status and privileges (e.g., manage email campaigns) or returns errors for bad requests.

Action Parameters

email
stringRequired

Action Response

data
object
successful
boolean
error

It returns the background process id which on completion calls the notify url that you have set in the input. file will be available in csv.

Action Parameters

exportAttributes
array
customContactFilter__actionForContacts
string
customContactFilter__actionForEmailCampaigns
string
customContactFilter__actionForSmsCampaigns
string
customContactFilter__listId
integer
customContactFilter__emailCampaignId
integer
customContactFilter__smsCampaignId
integer
notifyUrl
string

Action Response

data
object
successful
boolean
error

This endpoint fetches a list of dedicated ips for a sender using their senderid, detailing each ip’s address, domain, and weight. it handles success, bad requests, and unfound sender ids.

Action Parameters

senderId
integerRequired

Action Response

data
object
successful
boolean
error

Endpoint /corporate/subaccount/{id}“ allows for deletion of a specified sub-account by id. it returns 204 if successful, 400 for bad requests (e.g., invalid parameters), and 404 if the sub-account is not found.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

This endpoint fetches whatsapp campaigns, allowing filters by date, pagination, and sort by modification. it provides campaign name, status, template id, and message stats.

Action Parameters

startDate
string
endDate
string
limit
integerDefaults to 50
offset
integer
sort
stringDefaults to desc

Action Response

data
object
successful
boolean
error

The “/webhooks” endpoint enables webhook creation via a json payload specifying the events, url, and optional settings (description, batch mode, auth, headers, type). it returns the webhook’s id upon success, and detailed error messages for bad requests.

Action Parameters

description
string
url
stringRequired
events
arrayRequired
type
stringDefaults to transactional
domain
string
batched
boolean
headers
array

Action Response

data
object
successful
boolean
error

This endpoint retrieves files filtered by entity types, ids, dates, and supports pagination and sorting. it filters by companies, deals, contacts, etc., offering details like name and size. errors have codes and messages for invalid requests.

Action Parameters

entity
string
entityIds
string
dateFrom
integer
dateTo
integer
offset
integer
limit
integerDefaults to 50
sort
string

Action Response

data
object
successful
boolean
error

Validates a sender with a provided otp via put request on ‘/senders/{senderid}/validate’. requires senderid in the path and an otp in the json body. responses include 204 (verified), 400 (bad request), and 404 (sender id not found).

Action Parameters

senderId
integerRequired
otp
integerRequired

Action Response

data
object
successful
boolean
error

The ‘/transactionalsms/smd’ post endpoint sends sms (transactional/marketing), requiring sender, recipient, content, and options. success leads to a 201 status, messageid, credits used; failures return error codes/messages.

Action Parameters

sender
stringRequired
recipient
stringRequired
content
stringRequired
type
stringDefaults to transactional
tag
string
webUrl
string
unicodeEnabled
boolean
organisationPrefix
string

Action Response

data
object
successful
boolean
error

This endpoint provides the last 90 days’ contact stats by default. for older data, use the get contact campaign stats endpoint with specific date ranges. more info: https://developers.brevo.com/reference/contacts-7#getcontactstats

Action Parameters

identifier
stringRequired
startDate
string
endDate
string

Action Response

data
object
successful
boolean
error

Get a unique url to share & import an email template from one brevo account to another.

Action Parameters

campaignId
integerRequired

Action Response

data
object
successful
boolean
error

Get details of a specific task by its id in the crm system. requires the task’s unique string id. returns task details, including type, name, and related contacts, deals, and companies. possible errors: 400 (invalid id) and 404 (task not found).

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Update whatsapp campaign details like name, status, schedule, and recipients using the campaign id. supports campaign edits, rescheduling, and recipient list updates. responses detail update success, deletion, or errors like bad requests.

Action Parameters

campaignId
integerRequired
campaignName
string
campaignStatus
stringDefaults to scheduled
rescheduleFor
string
recipients__excludedListIds
array
recipients__listIds
array
recipients__segments
array

Action Response

data
object
successful
boolean
error

Get daily aggregated sms reports covering requests, deliveries, and more, customizable by date, days past, and tags, with detailed stats and sorting options.

Action Parameters

startDate
string
endDate
string
days
integer
tag
string
sort
stringDefaults to desc

Action Response

data
object
successful
boolean
error

Fetch the content of a sent transactional email using its unique id. this includes email details like recipient, subject, send date, events, body content, and attachment count.

Action Parameters

uuid
stringRequired

Action Response

data
object
successful
boolean
error

Brevo provides email, calls, and automations with customizable access levels. permissions vary by plan, with all features access for complete control. selection of features and permissions is crucial when adding users.

Action Parameters

email
stringRequired
all_features_access
booleanRequired
privileges
arrayRequired

Action Response

data
object
successful
boolean
error

This endpoint permits updating specific crm task details (e.g., name, duration, type, date, notes, status, assignments, linked entities) and reminders. it returns error messages for invalid data or missing task id.

Action Parameters

id
stringRequired
name
string
duration
integer
taskTypeId
string
date
string
notes
string
done
boolean
assignToId
string
contactsIds
array
dealsIds
array
companiesIds
array
reminder__value
integer
reminder__unit
string
reminder__types
array

Action Response

data
object
successful
boolean
error

Only agents’ messages can be edited.

Action Parameters

id
stringRequired
text
stringRequired

Action Response

data
object
successful
boolean
error

This get endpoint fetches details for a deal using its id, including attributes and linked contacts/companies. it requires an ‘id’ parameter and returns status codes 200, 400 for invalid ids, and 404 for missing deals.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint facilitates creating or updating ecommerce products, allowing post of details like id and price. it returns 201 for creation (including product id) or 204 for updates, and a 400 error for invalid requests.

Action Parameters

id
stringRequired
name
stringRequired
url
string
imageUrl
string
sku
string
price
integer
categories
array
parentId
string
metaInfo
object
updateEnabled
boolean
deletedAt
string

Action Response

data
object
successful
boolean
error

Update a transactional email template by specifying a template id and providing updated details such as tag, sender info, template name, content, and more. supports modifying template status and attaching files via url.

Action Parameters

templateId
integerRequired
tag
string
sender__name
string
sender__email
string
sender__id
integer
templateName
string
htmlContent
string
htmlUrl
string
subject
string
replyTo
string
toField
string
attachmentUrl
string
isActive
boolean

Action Response

data
object
successful
boolean
error

The put endpoint ‘/organization/user/invitation/revoke/{email}’ revokes user permissions via email, returning status and credit notes on success, and manages unauthorized access with error codes and messages.

Action Parameters

email
stringRequired

Action Response

data
object
successful
boolean
error

The /reseller/children endpoint enables resellers to view child account info, supporting pagination via limit and offset. it shows details like name, email, credits, and handles errors like unauthorized access.

Action Parameters

limit
integerDefaults to 10
offset
integer

Action Response

data
object
successful
boolean
error

This endpoint will update the sub-account plan

Action Parameters

id
integerRequired
credits__email
integer
features__users
integer
features__landingPage
integer
features__inbox
integer

Action Response

data
object
successful
boolean
error

This get endpoint at ‘/contacts/attributes’ lists all available contact attributes in your account. it responds with attribute details including name, category (normal, transactional, etc.), type (text, date, etc.), and enumeration for category types.

Action Parameters

Action Response

data
object
successful
boolean
error

This endpoint enables users to delete specific, a batch, or all contacts from a list using listid. contacts can be specified by emails, ids, or selecting all. the response details successes, failures, and a process id for batch deletions.

Action Parameters

listId
integerRequired

Action Response

data
object
successful
boolean
error

The ‘/contacts/lists’ post endpoint creates a contact list in a folder by its id and list name, returning the new list’s id on success or error codes and messages on failure.

Action Parameters

name
stringRequired
folderId
integerRequired

Action Response

data
object
successful
boolean
error

This openapi endpoint fetches lists from a contact folder with options for limit, offset, and sort. it details list id, name, subscriber count, supports sorting, pagination, and flags errors like bad requests or missing folders.

Action Parameters

folderId
integerRequired
limit
integerDefaults to 10
offset
integer
sort
stringDefaults to desc

Action Response

data
object
successful
boolean
error

This endpoint allows to update a group of sub-accounts

Action Parameters

id
stringRequired
groupName
string
subAccountIds
array

Action Response

data
object
successful
boolean
error

This endpoint will submit a request to get the history of webhooks in the csv file. the link to download the csv file will be sent to the webhook that was provided in the notifyurl.

Action Parameters

Action Response

data
object
successful
boolean
error

This endpoint fetches organization user activity logs, allows date range filtering, and supports pagination. it returns activities with details like type, time, email, ip, and browser info.

Action Parameters

startDate
string
endDate
string
limit
integerDefaults to 10
offset
integer

Action Response

data
object
successful
boolean
error

This endpoint will show the aggregated stats for past 30 days by default if startdate and enddate or days is not passed. the date range can not exceed 90 days

Action Parameters

limit
integerDefaults to 2500
offset
integer
startDate
string
endDate
string
days
integer
email
string
event
string
tags
string
messageId
string
templateId
integer
sort
stringDefaults to desc

Action Response

data
object
successful
boolean
error

This endpoint allows for the deletion of a specific file by id. on success, it returns a 204 status. errors related to invalid data or file not found are handled with 400 and 404 statuses, respectively, detailing the nature of the failure.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint allows for the deletion of an email campaign by providing the campaign’s id. on success, it confirms the deletion without content. errors return detailed messages for issues like bad requests or if the campaign id is not found.

Action Parameters

campaignId
integerRequired

Action Response

data
object
successful
boolean
error

Access deal pipeline details by id. fetch the name, id, and stages of a specific pipeline to manage deals effectively. returns data in json format. error codes included for invalid requests.

Action Parameters

pipelineID
stringRequired

Action Response

data
object
successful
boolean
error

This api endpoint (post /senders/domains) adds a new domain, requiring a domain name in json format in the body. it returns the domain id, name, a success message, and dns verification records upon success or error messages and codes if it fails.

Action Parameters

name
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint retrieves detailed account information, including user’s personal details (name, email, company, address), plan specifics, credits, transactional email account status, and marketing automation platform activation.

Action Parameters

Action Response

data
object
successful
boolean
error

Manages the transactional status of the order

Action Parameters

id
stringRequired
createdAt
stringRequired
updatedAt
stringRequired
status
stringRequired
amount
integerRequired
products
arrayRequired
email
string
billing__address
string
billing__city
string
billing__countryCode
string
billing__phone
string
billing__postCode
string
billing__paymentMethod
string
billing__region
string
coupons
array

Action Response

data
object
successful
boolean
error

Delete an existing webhook by its id. returns “webhook deleted” on success or detailed error messages for failures like invalid parameters, permissions issues, and more.

Action Parameters

webhookId
integerRequired

Action Response

data
object
successful
boolean
error

This endpoint will provide the list all the sub-accounts of the master account.

Action Parameters

offset
integerRequired
limit
integerRequired

Action Response

data
object
successful
boolean
error

Update a reseller’s child account status by id, including email, sms, marketing, and platform preferences. requires child id and status in json. responses show update success or errors for invalid requests/permissions.

Action Parameters

childIdentifier
stringRequired
transactionalEmail
boolean
transactionalSms
boolean
marketingAutomation
boolean
smsCampaign
boolean

Action Response

data
object
successful
boolean
error

The “/senders” [get] endpoint fetches a list of account senders, allowing ip/domain filtering. it reveals sender id, name, email, status, and ips, supports dedicated ip filters, and reports success or bad request errors.

Action Parameters

ip
string
domain
string

Action Response

data
object
successful
boolean
error

This endpoint will show the aggregated stats for past 90 days by default if startdate and enddate or days is not passed. the date range can not exceed 90 days

Action Parameters

startDate
string
endDate
string
days
integer
tag
string

Action Response

data
object
successful
boolean
error

Endpoint allows resellers to create a domain for a child account by specifying the child’s identifier. it requires a json body with the domain. responses include domain added, bad request, unauthorized reseller, and child not found scenarios.

Action Parameters

childIdentifier
stringRequired
domain
string

Action Response

data
object
successful
boolean
error

The post /crm/files endpoint enables file uploads, linking them to crm entities. it requires multipart/form-data and returns ids upon success or error details on failure.

Action Parameters

file
object
dealId
string
contactId
object
companyId
string

Action Response

data
object
successful
boolean
error

This endpoint can fetch all created external feeds.

Action Parameters

search
string
startDate
string
endDate
string
sort
stringDefaults to desc
authType
string
limit
integerDefaults to 50
offset
integer

Action Response

data
object
successful
boolean
error

It returns a session [token] which will remain valid for a short period of time. a child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token]

Action Parameters

childIdentifier
stringRequired

Action Response

data
object
successful
boolean
error

Deletes a specified domain from the system. requires the domain name in the path. responses include success (200 ok, domain deleted), bad request (400, with various error codes), and not found (404, domain does not exist).

Action Parameters

domainName
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint retrieves crm notes, supporting filters (entity type, ids, date range), pagination, and sorting by creation date. it returns note content, ids, author, timestamps, and issues a 400 error for invalid queries.

Action Parameters

entity
string
entityIds
string
dateFrom
integer
dateTo
integer
offset
integer
limit
integerDefaults to 50
sort
string

Action Response

data
object
successful
boolean
error

Endpoint ‘/crm/deals’ allows for deal creation with required name & optional attributes like owner, amount, pipeline, & stage. supports json requests & returns the created deal id with 201 or 400 for invalid data.

Action Parameters

name
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint allows creating or updating a contact with various options like email, sms settings, and custom attributes. successful creation returns the contact id, while updates and errors have specific responses.

Action Parameters

email
string
ext_id
string
attributes
object
emailBlacklisted
boolean
smsBlacklisted
boolean
listIds
array
updateEnabled
boolean
smtpBlacklistSender
array

Action Response

data
object
successful
boolean
error

This endpoint fetches contacts with pagination and supports filtering by creation or modification dates, and sorting. parameters: limit, offset, modifiedsince, createdsince, sort, segmentid, listids. returns contact details and count.

Action Parameters

limit
integerDefaults to 50
offset
integer
modifiedSince
string
createdSince
string
sort
stringDefaults to desc
segmentId
integer
listIds
array

Action Response

data
object
successful
boolean
error

Retrieve all webhooks via a get request to the /webhooks endpoint, with filter and sort options by type and date. the response includes description, url, id, events, creation/modification dates, and details on batching, authentication, and headers.

Action Parameters

type
stringDefaults to transactional
sort
stringDefaults to desc

Action Response

data
object
successful
boolean
error

This endpoint allows updating a coupon collection’s default coupon by specifying its id. provide the id in the path and updated values in the json body. responses include success (200 with details), bad request (400), and unauthorized (401).

Action Parameters

id
stringRequired
defaultCoupon
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint fetches contacts from a specific list with filter, pagination, and sorting options. it supports detailed queries, including attributes and status, and handles errors like bad requests and missing list ids.

Action Parameters

listId
integerRequired
modifiedSince
string
limit
integerDefaults to 50
offset
integer
sort
stringDefaults to desc

Action Response

data
object
successful
boolean
error

This api endpoint deletes a sender by id, requiring an integer id. successful deletions return a 204 code, while errors return 400 with details and 404 if the id is not found.

Action Parameters

senderId
integerRequired

Action Response

data
object
successful
boolean
error

A pdf will be sent to the specified email addresses

Action Parameters

campaignId
integerRequired
language
stringDefaults to fr
email__to
array
email__body
string

Action Response

data
object
successful
boolean
error

This endpoint allows you to delete a group of sub-organizations. when a group is deleted, the sub-organizations are no longer part of this group. the users associated with the group are no longer associated with the group once deleted.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint will retrieve inbound attachment with download token.

Action Parameters

downloadToken
stringRequired

Action Response

data
object
successful
boolean
error

Update a sender’s details by senderid, including name, email, and dedicated ips. supports replacing all existing ips with new ones if specified. errors for bad requests or missing sender id are handled with specific codes and messages.

Action Parameters

senderId
integerRequired
name
string
email
string
ips
array

Action Response

data
object
successful
boolean
error

Fetch aggregated sms activity reports over a specified period using start/end dates or a number of past days. includes metrics like delivered, bounced, and replied sms. filters available for specific tags.

Action Parameters

startDate
string
endDate
string
days
integer
tag
string

Action Response

data
object
successful
boolean
error

This endpoint fetches invited organization users, detailing their email, ownership, activation status, and feature access (e.g., marketing, conversations, crm). responses can be successful user data or a 400 error for bad requests.

Action Parameters

Action Response

data
object
successful
boolean
error

This endpoint allows creation of email campaigns with json, detailing name, sender, and content. it requires essential fields, supports html and a/b testing. success yields a 201 status and campaign id; failures return a 400 error.

Action Parameters

tag
string
sender__name
string
sender__email
string
sender__id
integer
name
stringRequired
htmlContent
string
htmlUrl
string
templateId
integer
scheduledAt
string
subject
string
previewText
string
replyTo
string
toField
string
recipients__exclusionListIds
array
recipients__listIds
array
recipients__segmentIds
array
attachmentUrl
string
inlineImageActivation
boolean
mirrorActive
boolean
footer
string
header
string
utmCampaign
string
params
object
sendAtBestTime
boolean
abTesting
boolean
subjectA
string
subjectB
string
splitRule
integer
winnerCriteria
string
winnerDelay
integer
ipWarmupEnable
boolean
initialQuota
integer
increaseRate
integer
unsubscriptionPageId
string
updateFormId
string

Action Response

data
object
successful
boolean
error

This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://account-app.brevo.com/account/login/sub-account/sso/[token], where [token] will be replaced by the actual token.

Action Parameters

id
integerRequired
email
string
target
string
url
string

Action Response

data
object
successful
boolean
error

This endpoint provides detailed data on an sms campaign, including content, status, schedule, sender, dates, recipient data, and delivery statistics, with error handling for invalid requests.

Action Parameters

campaignId
integerRequired

Action Response

data
object
successful
boolean
error

This endpoint enables users to create tasks in the crm, requiring task name, type id, and due date, with options for additional details. successful creation yields a unique task id.

Action Parameters

name
stringRequired
duration
integer
taskTypeId
stringRequired
date
stringRequired
notes
string
done
boolean
assignToId
string
contactsIds
array
dealsIds
array
companiesIds
array
reminder__value
integer
reminder__unit
string
reminder__types
array

Action Response

data
object
successful
boolean
error

The /products/batch endpoint allows for batch creation and updating of products in an ecommerce system. it accepts a json request body detailing product information, such as id, name, and price. responses include counts of created and updated products.

Action Parameters

products
arrayRequired
updateEnabled
boolean

Action Response

data
object
successful
boolean
error

This endpoint checks an admin’s permissions via email, supporting a get request for detailed user status, group associations, and feature access specifics, including api keys, plans, and management of users and apps.

Action Parameters

email
stringRequired

Action Response

data
object
successful
boolean
error

Endpoint “/contacts/folders” allows creating a contact folder. send a post request with the folder’s name in json format. on success, returns a 201 status with the created folder’s id. possible errors include bad requests and specific failure codes.

Action Parameters

name
string

Action Response

data
object
successful
boolean
error

This endpoint facilitates the creation or update of ecommerce categories, requiring json details like id for updates, and name for creation. creation returns status 201 with the category’s id; updates return 204. errors give a 400 status.

Action Parameters

id
stringRequired
name
string
url
string
updateEnabled
boolean
deletedAt
string

Action Response

data
object
successful
boolean
error

We recommend pinging this endpoint every minute for as long as the agent has to be considered online.

Action Parameters

agentId
receivedFrom
agentEmail
agentName

Action Response

data
object
successful
boolean
error