Brevo

Learn how to use Brevo with Composio

Overview

Enum

BREVO

Description

Brevo (formerly Sendinblue) is an all-in-one email and SMS marketing platform that provides transactional messaging, marketing automation, contact management, and CRM tools to help businesses communicate and engage with their customers.

Authentication Details

api_key
stringRequired
client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
string

Actions

This tool allows you to create a new company in your brevo account.

Action Parameters

attributes
object
countryCode
integer
name
stringRequired

Action Response

data
object
error
successful
boolean

This tool creates a new email template or updates an existing one in brevo. if a ‘templateid’ is provided, it performs an update; otherwise, it creates a new template.

Action Parameters

attachmentUrl
string
htmlContent
string
htmlUrl
string
isActive
boolean
replyTo
string
sender
object
subject
string
tag
string
templateId
integer
templateName
string
toField
string

Action Response

data
object
error
successful
boolean

This tool allows you to create a new sms campaign in brevo. you can specify the campaign name, sender, content, recipients (by providing list ids, exclusion list ids, or segment ids), and optionally schedule the campaign for a specific time. you can also enable unicode characters, add an organization prefix, and include unsubscribe instructions.

Action Parameters

content
stringRequired
name
stringRequired
organisationPrefix
string
recipients
object
scheduledAt
string
sender
stringRequired
unicodeEnabled
boolean
unsubscribeInstruction
string

Action Response

data
object
error
successful
boolean

Deletes a company from brevo using its unique identifier.

Action Parameters

id
stringRequired

Action Response

data
object
error
successful
boolean

Action Parameters

identifier
stringRequired

Action Response

data
object
error
successful
boolean

This tool deletes an inactive email template from brevo. you need to provide the ‘templateid’ of the email template you want to delete. only inactive templates can be deleted.

Action Parameters

template_id
integerRequired

Action Response

data
object
error
successful
boolean

This tool deletes an existing sms campaign.

Action Parameters

campaign_id
integerRequired

Action Response

data
object
error
successful
boolean

This tool checks if a contact exists in brevo. it searches for a contact using either an email address or mobile number, with the email being prioritized if both are provided.

Action Parameters

email
string
mobile_number
string

Action Response

data
object
error
successful
boolean

This tool retrieves information about the brevo account, including account holder’s email, first name, last name, company name, and address, as well as details about the current plan such as type, credits, start date, and end date.

Action Parameters

Action Response

data
object
error
successful
boolean

This tool retrieves all contacts from your brevo account. it allows for pagination and filtering based on modification/creation dates, list ids, segment ids, and contact attributes.

Action Parameters

created_since
string
limit
integerDefaults to 50
list_ids
array
modified_since
string
offset
integer
segment_id
integer
sort
stringDefaults to desc

Action Response

data
object
error
successful
boolean

This tool retrieves a list of all email templates created in your brevo account. it corresponds to the get /v3/smtp/templates endpoint as per the brevo api documentation, with optional parameters for filtering (templatestatus), pagination (limit, offset), and sorting (asc/desc).

Action Parameters

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

Action Response

data
object
error
successful
boolean

This tool retrieves a list of all senders associated with the brevo account. senders are the email addresses or domains that are authorized to send emails through brevo. this action can be useful for managing and verifying sender identities.

Action Parameters

domain
string
ip
string

Action Response

data
object
error
successful
boolean

This tool retrieves the details of a specific company by its unique id.

Action Parameters

id
stringRequired

Action Response

data
object
error
successful
boolean

This tool retrieves detailed information about a specific contact in brevo. you can identify the contact using their email address (url-encoded), their unique contact id, or their sms attribute value.

Action Parameters

identifier
stringRequired

Action Response

data
object
error
successful
boolean

This tool retrieves a list of all sms campaigns created in brevo. it supports filtering by status, start date, and end date, and also allows controlling the number of results returned (limit), the starting point in the list (offset), and the sort order (asc or desc).

Action Parameters

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

Action Response

data
object
error
successful
boolean

Retrieves the details of a specific sms campaign.

Action Parameters

campaign_id
integerRequired

Action Response

data
object
error
successful
boolean

This action retrieves a list of all companies stored in the brevo crm. it supports pagination and filtering by name and other attributes.

Action Parameters

filters
string
limit
integerDefaults to 50
linkedContactsIds
array
linkedDealsIds
array
page
integer
sort
stringDefaults to desc
sortBy
string

Action Response

data
object
error
successful
boolean

This tool retrieves a list of all email campaigns associated with the user’s brevo account. it allows filtering by campaign type, status, start date, and end date. the response includes the total count of campaigns and an array of campaign objects, each containing details like id, name, subject, type, status, scheduled date/time, sender information, and optionally, campaign statistics.

Action Parameters

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

Action Response

data
object
error
successful
boolean

Action Parameters

abTesting
boolean
attachmentUrl
string
campaign_id
integerRequired
footer
string
header
string
htmlContent
string
htmlUrl
string
increaseRate
integer
initialQuota
integer
inlineImageActivation
boolean
ipWarmupEnable
boolean
mirrorActive
booleanDefaults to True
name
string
params
object
previewText
string
recipients
object
recurring
boolean
replyTo
string
scheduledAt
string
sendAtBestTime
boolean
sender
object
splitRule
integer
subject
string
subjectA
string
subjectB
string
tag
string
toField
string
unsubscriptionPageId
string
updateFormId
string
utmCampaign
string
winnerCriteria
string
winnerDelay
integer

Action Response

data
object
error
successful
boolean