Transactional-Email API

Send a transactional email Get the list of transactional emails on the basis of allowed filters Delete scheduled emails by batchId or messageId Get the personalized content of a sent transactional email Fetch scheduled emails by batchId or messageId

Transactional-Templates

Get the list of email templates Create an email template Returns the template information Update an email template Delete an inactive email template Send a template to your test list

Transactional-Statistics

Get your transactional email activity aggregated over a period of time Get your transactional email activity aggregated per day Get all your transactional email activity (unaggregated events)

Transactional-Blocked Contacts

Get the list of blocked or unsubscribed transactional contacts Unblock or resubscribe a transactional contact

Transactional-Blocked Domains

Get the list of blocked domains Add a new domain to the list of blocked domains Unblock an existing domain from the list of blocked domains

Transactional-Logs

Delete hardbounces Delete an SMTP transactional log

Transactional-Inbound Email Parsing

Get the list of all the events for the received emails.Fetch all events history for one particular received email.Retrieve inbound attachment with download token.

Transactional-Transactional SMS

Send SMS message to a mobile number

Transactional-SMS statistics

Get your SMS activity aggregated over a period of time Get your SMS activity aggregated per day Get all your SMS activity (unaggregated events)

Transactional-WhatsApp Transactional

Send a WhatsApp message Get all your WhatsApp activity (unaggregated events) Copy

Marketing-Email Campaigns

Get an email campaign report Update an email campaign Delete an email campaign Send an email campaign immediately, based on campaignId Send an email campaign to your test list Update an email campaign status Send the report of a campaign Get an A/B test email campaign results Get a shared template url Export the recipients of an email campaign Return all your created email campaigns Create an email campaign Upload an image to your account's image gallery

Marketing-SMS Campaigns

Returns the information for all your created SMS campaigns Creates an SMS campaign Get an SMS campaign Update an SMS campaign Delete an SMS campaign Send your SMS campaign immediately Update a campaign's status Send a test SMS campaign Export an SMS campaign's recipients Send an SMS campaign's report

Marketing-WhatsApp Campaigns

Get a WhatsApp campaign Delete a WhatsApp campaign Return all your created WhatsApp campaigns Return all your created WhatsApp templates Update a WhatsApp campaign Create and send a WhatsApp campaign Create a WhatsApp template Send your WhatsApp template for approval Get your WhatsApp API account information

Contact Management-Contacts

Get all the contacts Create a contact Create Contact via DOI (Double-Opt-In) Flow Update multiple contacts Export contacts Import contacts Get a contact's details Delete a contact Update a contact Get email campaigns' statistics for a contact

Contact Management-Folders

Get all folders Create a folder Returns a folder's details Update a folder Delete a folder (and all its lists)Get lists in a folder

Contact Management-Lists

Get all the lists Create a list Get contacts in a list Add existing contacts to a list Delete a contact from a list Get a list's details Update a list Delete a list

Contact Management-Attributes

List all attributes Update contact attribute Create contact attribute Delete an attribute

Accounts and settings-Webhooks

Get all webhooks Create a webhook Get a webhook details Update a webhook Delete a webhook

Accounts and settings-Reseller-Credits

Add Email and/or SMS credits to a specific child account Remove Email and/or SMS credits from a specific child account

Accounts and settings-Reseller-IP management

Associate a dedicated IP to the child Dissociate a dedicated IP to the child

Accounts and settings-Reseller-Domains

Get all sender domains for a specific child account Create a domain for a child account Update the sender domain of reseller's child based on the childIdentifier and domainName passed Delete the sender domain of the reseller child based on the childIdentifier and domainName passed

Accounts and settings-Reseller-Child accounts

Get a child account's details Update info of reseller's child based on the child identifier supplied Delete a single reseller child based on the child identifier supplied Update info of reseller's child account status based on the identifier supplied Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the childIdentifier supplied Get session token to access Sendinblue (SSO)Get the list of all children accounts Creates a reseller child

Accounts and settings-Process

Return all the processes for your account Return the informations for a process

Accounts and settings-Corporate

Get the details of requested master account Get the list of all the sub-accounts of the master account.Create a new sub-account under a master account.Generate SSO token to access Sendinblue Get sub-account details Delete a sub-account Update sub-account plan

Accounts and settings-Account data

Get your account information, plan and credits details Get user activity logs

Accounts and settings-Senders

Get the list of all your senders Create a new sender Get all the dedicated IPs for your account Update a sender Delete a sender Get all the dedicated IPs for a sender

Accounts and settings-Domains

Get the list of all your domains Create a new domain Delete a domain Validate domain configuration Authenticate a domain

Accounts and settings-User

Get the list of all your users Check user permission Revoke user permission Resend / Cancel invitation Send invitation to user Update permission for a user

Accounts and settings-External feeds

Fetch all External feeds Create an External feed Get an External feed by UUID Update an external feed Delete an External feed

Sales CRM-Companies

Get all Companies Create a company Get company attributes Link and Unlink company with contact and deal Get a company Delete a company Update a company Get pipeline stages

Sales CRM-Deals

Get all deals Create a deal Link and Unlink a deal with contacts and companies Get deal attributes Get a deal Delete a deal Update a deal

Sales CRM-Tasks

Get all tasks Create a task Get all task types Get a task Delete a task Update a task

Sales CRM-Notes

Get all notes Create a note Get a note Update a note Delete a note

Sales CRM-Files

Get all files Upload a file Download a file Delete a file Get file details

Conversations-Messages

Send a message as an agent Get a message Update a message sent by an agent Delete a message sent by an agent

Conversations-Status

Sets agent’s status to online for 2-3 minutes

Conversations-Pushed messages

Send an automated message to a visitor Get an automated message Update an automated message Delete an automated message

eCommerce-Orders

Get order details Create orders in batch Managing the status of the order

eCommerce-Categories

Get all categories Create/update a category Create categories in batch Get a category details

eCommerce-Products

Get all products Get a product's details Create/update a product Create products in batch

Activate eCommerce platform on your account Get attribution metrics for one or more Brevo campaigns Get detailed attribution metrics for a single Brevo campaign Get attributed product sales for a single Brevo campaign

Get a coupon collection by id Create a coupon collection Update a coupon collection by id Create coupons for a coupon collection

Events-Automation Tracker

Identify the user Track event Track link clicks Track page views

Create an Event

Transactional-Email API

Send a transactional email Get the list of transactional emails on the basis of allowed filters Delete scheduled emails by batchId or messageId Get the personalized content of a sent transactional email Fetch scheduled emails by batchId or messageId

Transactional-Templates

Get the list of email templates Create an email template Returns the template information Update an email template Delete an inactive email template Send a template to your test list

Transactional-Statistics

Get your transactional email activity aggregated over a period of time Get your transactional email activity aggregated per day Get all your transactional email activity (unaggregated events)

Transactional-Blocked Contacts

Get the list of blocked or unsubscribed transactional contacts Unblock or resubscribe a transactional contact

Transactional-Blocked Domains

Get the list of blocked domains Add a new domain to the list of blocked domains Unblock an existing domain from the list of blocked domains

Transactional-Logs

Delete hardbounces Delete an SMTP transactional log

Transactional-Inbound Email Parsing

Get the list of all the events for the received emails.Fetch all events history for one particular received email.Retrieve inbound attachment with download token.

Transactional-Transactional SMS

Send SMS message to a mobile number

Transactional-SMS statistics

Get your SMS activity aggregated over a period of time Get your SMS activity aggregated per day Get all your SMS activity (unaggregated events)

Transactional-WhatsApp Transactional

Send a WhatsApp message Get all your WhatsApp activity (unaggregated events) Copy

Marketing-Email Campaigns

Get an email campaign report Update an email campaign Delete an email campaign Send an email campaign immediately, based on campaignId Send an email campaign to your test list Update an email campaign status Send the report of a campaign Get an A/B test email campaign results Get a shared template url Export the recipients of an email campaign Return all your created email campaigns Create an email campaign Upload an image to your account's image gallery

Marketing-SMS Campaigns

Returns the information for all your created SMS campaigns Creates an SMS campaign Get an SMS campaign Update an SMS campaign Delete an SMS campaign Send your SMS campaign immediately Update a campaign's status Send a test SMS campaign Export an SMS campaign's recipients Send an SMS campaign's report

Marketing-WhatsApp Campaigns

Get a WhatsApp campaign Delete a WhatsApp campaign Return all your created WhatsApp campaigns Return all your created WhatsApp templates Update a WhatsApp campaign Create and send a WhatsApp campaign Create a WhatsApp template Send your WhatsApp template for approval Get your WhatsApp API account information

Contact Management-Contacts

Get all the contacts Create a contact Create Contact via DOI (Double-Opt-In) Flow Update multiple contacts Export contacts Import contacts Get a contact's details Delete a contact Update a contact Get email campaigns' statistics for a contact

Contact Management-Folders

Get all folders Create a folder Returns a folder's details Update a folder Delete a folder (and all its lists)Get lists in a folder

Contact Management-Lists

Get all the lists Create a list Get contacts in a list Add existing contacts to a list Delete a contact from a list Get a list's details Update a list Delete a list

Contact Management-Attributes

List all attributes Update contact attribute Create contact attribute Delete an attribute

Accounts and settings-Webhooks

Get all webhooks Create a webhook Get a webhook details Update a webhook Delete a webhook

Accounts and settings-Reseller-Credits

Add Email and/or SMS credits to a specific child account Remove Email and/or SMS credits from a specific child account

Accounts and settings-Reseller-IP management

Associate a dedicated IP to the child Dissociate a dedicated IP to the child

Accounts and settings-Reseller-Domains

Get all sender domains for a specific child account Create a domain for a child account Update the sender domain of reseller's child based on the childIdentifier and domainName passed Delete the sender domain of the reseller child based on the childIdentifier and domainName passed

Accounts and settings-Reseller-Child accounts

Get a child account's details Update info of reseller's child based on the child identifier supplied Delete a single reseller child based on the child identifier supplied Update info of reseller's child account status based on the identifier supplied Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the childIdentifier supplied Get session token to access Sendinblue (SSO)Get the list of all children accounts Creates a reseller child

Accounts and settings-Process

Return all the processes for your account Return the informations for a process

Accounts and settings-Corporate

Get the details of requested master account Get the list of all the sub-accounts of the master account.Create a new sub-account under a master account.Generate SSO token to access Sendinblue Get sub-account details Delete a sub-account Update sub-account plan

Accounts and settings-Account data

Get your account information, plan and credits details Get user activity logs

Accounts and settings-Senders

Get the list of all your senders Create a new sender Get all the dedicated IPs for your account Update a sender Delete a sender Get all the dedicated IPs for a sender

Accounts and settings-Domains

Get the list of all your domains Create a new domain Delete a domain Validate domain configuration Authenticate a domain

Accounts and settings-User

Get the list of all your users Check user permission Revoke user permission Resend / Cancel invitation Send invitation to user Update permission for a user

Accounts and settings-External feeds

Fetch all External feeds Create an External feed Get an External feed by UUID Update an external feed Delete an External feed

Sales CRM-Companies

Get all Companies Create a company Get company attributes Link and Unlink company with contact and deal Get a company Delete a company Update a company Get pipeline stages

Sales CRM-Deals

Get all deals Create a deal Link and Unlink a deal with contacts and companies Get deal attributes Get a deal Delete a deal Update a deal

Sales CRM-Tasks

Get all tasks Create a task Get all task types Get a task Delete a task Update a task

Sales CRM-Notes

Get all notes Create a note Get a note Update a note Delete a note

Sales CRM-Files

Get all files Upload a file Download a file Delete a file Get file details

Conversations-Messages

Send a message as an agent Get a message Update a message sent by an agent Delete a message sent by an agent

Conversations-Status

Sets agent’s status to online for 2-3 minutes

Conversations-Pushed messages

Send an automated message to a visitor Get an automated message Update an automated message Delete an automated message

eCommerce-Orders

Get order details Create orders in batch Managing the status of the order

eCommerce-Categories

Get all categories Create/update a category Create categories in batch Get a category details

eCommerce-Products

Get all products Get a product's details Create/update a product Create products in batch

Activate eCommerce platform on your account Get attribution metrics for one or more Brevo campaigns Get detailed attribution metrics for a single Brevo campaign Get attributed product sales for a single Brevo campaign

Get a coupon collection by id Create a coupon collection Update a coupon collection by id Create coupons for a coupon collection

Events-Automation Tracker

Identify the user Track event Track link clicks Track page views

Create an Event

Home Brevo eCommerce-OrdersManaging the status of the order

Managing the status of the order

POST {{baseUrl}}/v3/orders/status

HEADERS

Key	Datatype	Required	Description
`Accept`	string
`Content-Type`	string

Related Documentation

BrevoBrevo
Transactional-Email APITransactional Email Api 1
Transactional-Email APISend a transactional email
Transactional-Email APIGet the list of transactional emails on the basis of allowed filters
Transactional-Email APIDelete scheduled emails by batchId or messageId

Create orders in batch

eCommerce-Categories

BrevoAPI Documentation

Claim this page Report this page All Projects

Powered byQodex.ai