Jump to Content
Home
Guides
API Reference
Recipes
Changelog
Status
Home
Guides
Recipes
API Reference
Changelog
Home
Guides
API Reference
Recipes
Changelog
Status
Help Center
My API Keys 🔑
API Reference
Help Center
My API Keys 🔑
Home
Guides
Recipes
API Reference
Changelog
My Requests
Search
JUMP TO
Introduction
Getting started
Transactional
Transactional emails
Send a transactional email
post
Get the list of transactional emails on the basis of allowed filters
get
Get the personalized content of a sent transactional email
get
Delete an SMTP transactional log
delete
Get the list of email templates
get
Create an email template
post
Returns the template information
get
Update an email template
put
Delete an inactive email template
delete
Send a template to your test list
post
Get your transactional email activity aggregated over a period of time
get
Get your transactional email activity aggregated per day
get
Get all your transactional email activity (unaggregated events)
get
Unblock or resubscribe a transactional contact
delete
Get the list of blocked or unsubscribed transactional contacts
get
Get the list of blocked domains
get
Add a new domain to the list of blocked domains
post
Unblock an existing domain from the list of blocked domains
delete
Delete hardbounces
post
Fetch scheduled emails by batchId or messageId
get
Delete scheduled emails by batchId or messageId
delete
Transactional SMS
Send SMS message to a mobile number
post
Get your SMS activity aggregated over a period of time
get
Get your SMS activity aggregated per day
get
Get all your SMS activity (unaggregated events)
get
Inbound Parsing
Get the list of all the events for the received emails.
get
Fetch all events history for one particular received email.
get
Retrieve inbound attachment with download token.
get
Transactional WhatsApp
Send a WhatsApp message
post
Get all your WhatsApp activity (unaggregated events)
get
Marketing
Email Campaigns
Return all your created email campaigns
get
Create an email campaign
post
Get an email campaign report
get
Update an email campaign
put
Delete an email campaign
delete
Send an email campaign immediately, based on campaignId
post
Send an email campaign to your test list
post
Update an email campaign status
put
Send the report of a campaign
post
Get an A/B test email campaign results
get
Get a shared template url
get
Export the recipients of an email campaign
post
Upload an image to your account's image gallery
post
SMS Campaigns
Returns the information for all your created SMS campaigns
get
Creates an SMS campaign
post
Get an SMS campaign
get
Update an SMS campaign
put
Delete an SMS campaign
delete
Send your SMS campaign immediately
post
Update a campaign's status
put
Send a test SMS campaign
post
Export an SMS campaign's recipients
post
Send an SMS campaign's report
post
WhatsApp Campaigns
Get a WhatsApp campaign
get
Delete a WhatsApp campaign
delete
Update a WhatsApp campaign
put
Return all your created WhatsApp templates
get
Create and Send a WhatsApp campaign
post
Return all your created WhatsApp campaigns
get
Create a WhatsApp template
post
Send your WhatsApp template for approval
post
Get your WhatsApp API account information
get
Contact management
Contacts
Get all the contacts
get
Create a contact
post
Create Contact via DOI (Double-Opt-In) Flow
post
Get a contact's details
get
Delete a contact
delete
Update a contact
put
Update multiple contacts
post
Get email campaigns' statistics for a contact
get
List all attributes
get
Update contact attribute
put
Create contact attribute
post
Delete an attribute
delete
Delete a multiple-choice attribute option
delete
Get all folders
get
Create a folder
post
Returns a folder's details
get
Update a folder
put
Delete a folder (and all its lists)
delete
Get lists in a folder
get
Get all the lists
get
Create a list
post
Get a list's details
get
Update a list
put
Delete a list
delete
Get all the segments
get
Get contacts in a list
get
Add existing contacts to a list
post
Delete a contact from a list
post
Export contacts
post
Import contacts
post
events
Event
Create an event
post
Accounts and settings
Senders
Get the list of all your senders
get
Create a new sender
post
Update a sender
put
Delete a sender
delete
Validate Sender using OTP
put
Get all the dedicated IPs for a sender
get
Get all the dedicated IPs for your account
get
Domains
Get the list of all your domains
get
Create a new domain
post
Delete a domain
delete
Validate domain configuration
get
Authenticate a domain
put
Webhooks
Get all webhooks
get
Create a webhook
post
Get a webhook details
get
Update a webhook
put
Delete a webhook
delete
Export all webhook events
post
Account
Get your account information, plan and credits details
get
Get user activity logs
get
Master account
Get the list of all the sub-accounts of the master account.
get
Create a new sub-account under a master account.
post
Get sub-account details
get
Delete a sub-account
delete
Update sub-account plan
put
Generate SSO token to access admin account
post
Generate SSO token to access sub-account
post
Get the details of requested master account
get
Create an API key for a sub-account
post
Enable/disable sub-account application(s)
put
Create a group of sub-accounts
post
List of all IPs
get
Associate an IP to sub-accounts
post
Dissociate an IP to sub-accounts
put
GET a group details
get
Update a group of sub-accounts
put
Delete a group
delete
Delete sub-account from group
put
Send invitation to an admin user
post
Resend / cancel admin user invitation
put
Revoke an admin user
delete
Get the list of all admin users
get
Check admin user permissions
get
Change admin user permissions
put
Get the list of groups
get
User
Get the list of all your users
get
Check user permission
get
Revoke user permission
put
Resend / Cancel invitation
put
Send invitation to user
post
Update permission for a user
post
Process
Return all the processes for your account
get
Return the informations for a process
get
External Feeds
Fetch all external feeds
get
Create an external feed
post
Get an external feed by UUID
get
Update an external feed
put
Delete an external feed
delete
Sales CRM
Companies
Get all Companies
get
Create a company
post
Get a company
get
Delete a company
delete
Update a company
patch
Create a company/deal attribute
post
Get company attributes
get
Link and Unlink company with contact and deal
patch
Import companies(creation and updation)
post
Deals
Get pipeline stages
get
Get a pipeline
get
Get all pipelines
get
Get deal attributes
get
Get all deals
get
Create a deal
post
Get a deal
get
Delete a deal
delete
Update a deal
patch
Link and Unlink a deal with contacts and companies
patch
Import deals(creation and updation)
post
Tasks
Get all task types
get
Get all tasks
get
Create a task
post
Get a task
get
Delete a task
delete
Update a task
patch
Notes
Get all notes
get
Create a note
post
Get a note
get
Update a note
patch
Delete a note
delete
Files
Get all files
get
Upload a file
post
Download a file
get
Delete a file
delete
Get file details
get
Brevo API
Conversations
Send a message as an agent
post
Get a message
get
Update a message sent by an agent
put
Delete a message sent by an agent
delete
Send an automated message to a visitor
post
Get an automated message
get
Update an automated message
put
Delete an automated message
delete
Sets agent’s status to online for 2-3 minutes
post
Ecommerce
Activate the eCommerce app
post
Set the ISO 4217 compliant display currency code for your Brevo account
post
Get the ISO 4217 compliant display currency code for your Brevo account
get
Get attribution metrics for one or more Brevo campaigns or workflows
get
Get detailed attribution metrics for a single Brevo campaign or workflow
get
Get attributed product sales for a single Brevo campaign or workflow
get
Get order details
get
Managing the status of the order
post
Create orders in batch
post
Return all your categories
get
Create/Update a category
post
Get a category details
get
Create categories in batch
post
Return all your products
get
Create/Update a product
post
Get a product's details
get
Create products in batch
post
Coupons
Get all your coupon collections
get
Create а coupon collection
post
Get a coupon collection by id
get
Update a coupon collection by id
patch
Create coupons for a coupon collection
post
Payments
Create a payment request
post
Get payment request details
get
Delete a payment request.
delete
Tracker
Restful endpoints
Identify the user
post
Track event
post
Track link clicks
post
Track page views
post
Loyalty
Program
Get loyalty program list
get
Create loyalty program
post
Get loyalty program Info
get
Update loyalty program
put
Partially update loyalty program
patch
Delete Loyalty Program
delete
Publish loyalty program
post
Create subscription
post
Create subscription member
post
Delete subscription member
delete
Delete subscription
delete
Get subscription info
get
Get Subscription Data
get
Rewards
Attribute reward to a contact
post
Validates a voucher
post
Get Reward list
get
Revoke reward
delete
Create reward redemption for a contact
post
Reward completion for a contact
post
Balance
Get balance definition list
get
Create balance definition
post
Get balance definition
get
Update balance definition
put
Delete balance definition
delete
Create balance limits
post
Get balance limits
get
Delete balance limit
delete
Updates balance limit
put
Get subscription balances
get
Get balance list
get
Create new transaction
post
Complete transaction
post
Cancel transaction
post
Create balance order
post
Tier
Create tier group
post
Get tier group page
get
Update tier group
put
Delete tier group
delete
Get tier group by Id
get
Get tier page
get
Create new tier
post
Delete tier
delete
Update tier
put
Add subscription to a tier
post
