Brevo
Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :
- Manage your campaigns and get the statistics
- Manage your contacts
- Send transactional Emails and SMS
- and much more...
You can download our wrappers at https://github.com/orgs/brevo Possible responses | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | | 422 | Error. Unprocessable Entity |
Operations
Get account details
Create categories in batch
Return all your categories
Get a category details
Create/Update a category
Get all Companies
Delete a company
Get a company
Update a company
Import companies(creation and updation)
Link and Unlink company with contact and deal
Create a company
Delete an attribute
Create contact attribute
Update contact attribute
Delete a multiple-choice attribute option
List all attributes
Update multiple contacts
Create Contact via DOI (Double-Opt-In) Flow
Export contacts
Delete a folder (and all its lists)
Returns a folder's details
Get lists in a folder
Update a folder
Get all folders
Create a folder
Get all the contacts
Get email campaigns' statistics for a contact
Delete a contact
Get a contact's details
Update a contact
Import contacts
Get all the lists
Add existing contacts to a list
Get contacts in a list
Delete a contact from a list
Delete a list
Get a list's details
Update a list
Create a list
Create a contact
Get all the segments
Sets agent’s status to online for 2-3 minutes
Delete a message sent by an agent
Get a message
Update a message sent by an agent
Send a message as an agent
Delete an automated message
Get an automated message
Update an automated message
Send an automated message to a visitor
Set visitor group assignment
Delete a group
GET a group details
Update a group of sub-accounts
Create a new group of sub-accounts
Delete sub-account from group
Get the list of groups
Get the list of all admin users
List of all IPs
Get the details of requested master account
Generate SSO token to access admin account
Get the list of all the sub-accounts of the master account.
Enable/disable sub-account application(s)
Delete a sub-account
Get sub-account details
Update sub-account plan
Associate an IP to sub-accounts
Dissociate an IP to sub-accounts
Create an API key for a sub-account
Create a new sub-account under a master account.
Generate SSO token to access sub-account
Update sub-accounts plan
Check admin user permissions
Change admin user permissions
Resend / cancel admin user invitation
Send invitation to an admin user
Revoke an admin user
Get all your coupon collections
Get a coupon collection by id
Update a coupon collection by id
Create а coupon collection
Create coupons for a coupon collection
Get company attributes
Get deal attributes
Create a company/deal attribute
Get all deals
Delete a deal
Get a deal
Update a deal
Import deals(creation and updation)
Link and Unlink a deal with contacts and companies
Create a deal
Get all files
Get file details
Delete a file
Download a file
Upload a file
Get all notes
Delete a note
Get a note
Update a note
Create a note
Get all pipelines
Get a pipeline
Get all tasks
Delete a task
Get a task
Update a task
Create a task
Get all task types
Activate the eCommerce app
Get detailed attribution metrics for a single Brevo campaign or workflow
Get attribution metrics for one or more Brevo campaigns or workflows
Get attributed product sales for a single Brevo campaign or workflow
Get the ISO 4217 compliant display currency code for your Brevo account
Set the ISO 4217 compliant display currency code for your Brevo account
Get an A/B test email campaign results
Delete an email campaign
Export the recipients of an email campaign
Get an email campaign report
Update an email campaign
Send an email campaign immediately, based on campaignId
Send the report of a campaign
Send an email campaign to your test list
Get a shared template url
Update an email campaign status
Return all your created email campaigns
Upload an image to your account's image gallery
Create an email campaign
Create an event
Get all external feeds
Create external feed
Delete external feed
Get external feed details
Update external feed
Retrieve inbound attachment with download token.
Get the list of all the events for the received emails.
Fetch all events history for one particular received email.
Get Active Balances API
Delete balance definition
Get balance definition
Delete balance limit
Get balance limits
Updates balance limit
Create balance limits
Update balance definition
Get balance definition list
Create balance definition
Get balance list
Create balance order
Get subscription balances
Create subscription balances
Get Transaction History API
Create new transaction
Cancel transaction
Complete transaction
Get loyalty program list
Get Subscription Data
Delete Loyalty Program
Get loyalty program Info
Partially update loyalty program
Publish loyalty program
Update loyalty program
Delete subscription member
Create subscription member
Create subscription
Create loyalty program
Get Reward Page API
Create a reward
Create a voucher
Create redeem voucher request
Complete redeem voucher request
Revoke vouchers
Get reward information
Validate a reward
Get voucher for a contact
List tier groups
Delete tier group
Get tier group
Update tier group
Create a tier group
List tiers
Delete tier
Update tier
Delete multiple object records (up to 1000) asynchronously
Create/Update object records in bulk
Get the list of object records and total records count for an object.
Get order details
Create orders in batch
Managing the status of the order
Retrieves user activity logs from your organization for security monitoring and audit compliance. Use this to: Monitor user login activities and access patterns Track account modifications and conf...
Get the list of all your users
Check user permission
Resend / Cancel invitation
Revoke user permission
Send invitation to user
Update permission for a user
Delete a payment request.
Get payment request details
Create a payment request
Get background processes
Get process details
Create products in batch
Return all your products
Create a product alert for a contact
Get a product's details
Create/Update a product
Authenticates a specific domain. Use this to: Authenticate a domain Verify DNS record configuration Complete domain setup for sending Enable domain for email authentication Key information returned...
Deletes a domain from Brevo. Use this to: Remove existing domains Clean up unused domain configurations Remove test domains Key information returned: Success confirmation message
Retrieves configuration of a specific domain, to know if the domain is valid or not. Use this to: Check domain configuration Validate a domain configuration Monitor DNS record status Troubleshoot a...
Retrieves all domains associated with the account. Use this to: List all domains Verify domain existence Check domain authentication and verification status Monitor domain configuration and provide...
Creates a new domain in Brevo. Use this to: Add new domains for sending emails Set up domain authentication for better deliverability Configure DNS records for email authentication Establish domain...
Get email senders
Retrieves all dedicated IPs associated with your Brevo account. Use this to: List all your dedicated IPs Check the status of your dedicated IPs (active/inactive) Find IP addresses and associated do...
Create email sender
Deletes an email sender from your Brevo account. Use this to: Remove senders that are no longer needed Clean up sender configurations Remove duplicate or test senders Key information returned: Succ...
Retrieves the dedicated IPs associated with a specific sender. Use this to: Check IP configuration for a sender Verify dedicated IP associations Get IP details for troubleshooting Monitor sender IP...
Updates an existing email sender's configuration. Use this to: Modify sender display name or email address Update dedicated IP associations Change sender configuration settings Correct sender infor...
Validates a sender using the OTP (One-Time Password) received via email. Use this to: Complete sender verification process Activate a newly created sender Verify ownership of the sender email addre...
Delete an SMS campaign
Export an SMS campaign's recipients
Get an SMS campaign
Update an SMS campaign
Send your SMS campaign immediately
Send an SMS campaign's report
Send a test SMS campaign
Update a campaign's status
Returns the information for all your created SMS campaigns
Creates an SMS campaign
Unblock or resubscribe a transactional contact
Get the list of blocked or unsubscribed transactional contacts
Unblock an existing domain from the list of blocked domains
Get the list of blocked domains
Add a new domain to the list of blocked domains
Delete hardbounces
Delete scheduled emails by batchId or messageId
Send a transactional email
Get the list of transactional emails on the basis of allowed filters
Get the personalized content of a sent transactional email
Fetch scheduled emails by batchId or messageId
Delete an SMTP transactional log
Get your transactional email activity aggregated over a period of time
Get all your transactional email activity (unaggregated events)
Get your transactional email activity aggregated per day
Generate the rendered preview of transactional template
Get the list of email templates
Create an email template
Delete an inactive email template
Returns the template information
Update an email template
Send a template to your test list
Send SMS message asynchronously to a mobile number
Send SMS message to a mobile number
Get your SMS activity aggregated over a period of time
Get all your SMS activity (unaggregated events)
Get your SMS activity aggregated per day
Return all your created SMS templates
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.
Retrieves all webhooks from your Brevo account with filtering and sorting options. Use this to: Monitor webhook configurations and event handling List webhooks by type (transactional, marketing, in...
Creates a new webhook to receive real-time notifications for specified events. Use this to: Set up event notifications for transactional or marketing emails Configure webhook endpoints for campaign...
Permanently deletes a webhook and stops all event notifications. Use this to: Remove unused or obsolete webhook configurations Clean up webhook endpoints and subscriptions Stop event notifications ...
Retrieves detailed information about a specific webhook configuration. Use this to: Get complete webhook configuration and settings Check webhook event subscriptions and triggers Review authenticat...
Updates an existing webhook configuration and event subscriptions. Use this to: Modify webhook event subscriptions and triggers Update webhook URL and endpoint configuration Change authentication s...
Send a WhatsApp message
Get all your WhatsApp activity (unaggregated events)
Delete a WhatsApp campaign
Get a WhatsApp campaign
Update a WhatsApp campaign
Get your WhatsApp API account information
Return all your created WhatsApp campaigns
Create and Send a WhatsApp campaign
Send your WhatsApp template for approval
Return all your created WhatsApp templates
Create a WhatsApp template