Jump to Content
Brevo APIHomeGuidesAPI ReferenceRecipesChangelogStatus
HomeGuidesRecipesAPI ReferenceChangelog
HomeGuidesAPI ReferenceRecipesChangelogStatusHelp CenterMy API Keys 🔑Brevo API
API Reference
Help CenterMy API Keys 🔑
HomeGuidesRecipesAPI ReferenceChangelog

Introduction

  • Getting started

Transactional

  • Transactional emails
    • Send a transactional emailpost
    • Get the list of transactional emails on the basis of allowed filtersget
    • Get the personalized content of a sent transactional emailget
    • Delete an SMTP transactional logdelete
    • Get the list of email templatesget
    • Create an email templatepost
    • Returns the template informationget
    • Update an email templateput
    • Delete an inactive email templatedelete
    • Send a template to your test listpost
    • Get your transactional email activity aggregated over a period of timeget
    • Get your transactional email activity aggregated per dayget
    • Get all your transactional email activity (unaggregated events)get
    • Unblock or resubscribe a transactional contactdelete
    • Get the list of blocked or unsubscribed transactional contactsget
    • Get the list of blocked domainsget
    • Add a new domain to the list of blocked domainspost
    • Unblock an existing domain from the list of blocked domainsdelete
    • Delete hardbouncespost
    • Fetch scheduled emails by batchId or messageIdget
    • Delete scheduled emails by batchId or messageIddelete
  • Transactional SMS
    • Send SMS message to a mobile numberpost
    • Get your SMS activity aggregated over a period of timeget
    • Get your SMS activity aggregated per dayget
    • 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 messagepost
    • Get all your WhatsApp activity (unaggregated events)get

Marketing

  • Email Campaigns
    • Return all your created email campaignsget
    • Create an email campaignpost
    • Get an email campaign reportget
    • Update an email campaignput
    • Delete an email campaigndelete
    • Send an email campaign immediately, based on campaignIdpost
    • Send an email campaign to your test listpost
    • Update an email campaign statusput
    • Send the report of a campaignpost
    • Get an A/B test email campaign resultsget
    • Get a shared template urlget
    • Export the recipients of an email campaignpost
    • Upload an image to your account's image gallerypost
  • SMS Campaigns
    • Returns the information for all your created SMS campaignsget
    • Creates an SMS campaignpost
    • Get an SMS campaignget
    • Update an SMS campaignput
    • Delete an SMS campaigndelete
    • Send your SMS campaign immediatelypost
    • Update a campaign's statusput
    • Send a test SMS campaignpost
    • Export an SMS campaign's recipientspost
    • Send an SMS campaign's reportpost
  • WhatsApp Campaigns
    • Get a WhatsApp campaignget
    • Delete a WhatsApp campaigndelete
    • Update a WhatsApp campaignput
    • Return all your created WhatsApp templatesget
    • Create and Send a WhatsApp campaignpost
    • Return all your created WhatsApp campaignsget
    • Create a WhatsApp templatepost
    • Send your WhatsApp template for approvalpost
    • Get your WhatsApp API account informationget

Contact management

  • Contacts
    • Get all the contactsget
    • Create a contactpost
    • Create Contact via DOI (Double-Opt-In) Flowpost
    • Get a contact's detailsget
    • Delete a contactdelete
    • Update a contactput
    • Update multiple contactspost
    • Get email campaigns' statistics for a contactget
    • List all attributesget
    • Update contact attributeput
    • Create contact attributepost
    • Delete an attributedelete
    • Delete a multiple-choice attribute optiondelete
    • Get all foldersget
    • Create a folderpost
    • Returns a folder's detailsget
    • Update a folderput
    • Delete a folder (and all its lists)delete
    • Get lists in a folderget
    • Get all the listsget
    • Create a listpost
    • Get a list's detailsget
    • Update a listput
    • Delete a listdelete
    • Get all the segmentsget
    • Get contacts in a listget
    • Add existing contacts to a listpost
    • Delete a contact from a listpost
    • Export contactspost
    • Import contactspost

events

  • Event
    • Create an eventpost

Accounts and settings

  • Senders
    • Get the list of all your sendersget
    • Create a new senderpost
    • Update a senderput
    • Delete a senderdelete
    • Validate Sender using OTPput
    • Get all the dedicated IPs for a senderget
    • Get all the dedicated IPs for your accountget
  • Domains
    • Get the list of all your domainsget
    • Create a new domainpost
    • Delete a domaindelete
    • Validate domain configurationget
    • Authenticate a domainput
  • Webhooks
    • Get all webhooksget
    • Create a webhookpost
    • Get a webhook detailsget
    • Update a webhookput
    • Delete a webhookdelete
    • Export all webhook eventspost
  • Account
    • Get your account information, plan and credits detailsget
    • Get user activity logsget
  • 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 detailsget
    • Delete a sub-accountdelete
    • Update sub-account planput
    • Update sub-accounts planput
    • Generate SSO token to access admin accountpost
    • Generate SSO token to access sub-accountpost
    • Get the details of requested master accountget
    • Create an API key for a sub-accountpost
    • Enable/disable sub-account application(s)put
    • Create a group of sub-accountspost
    • List of all IPsget
    • Associate an IP to sub-accountspost
    • Dissociate an IP to sub-accountsput
    • GET a group detailsget
    • Update a group of sub-accountsput
    • Delete a groupdelete
    • Delete sub-account from groupput
    • Send invitation to an admin userpost
    • Resend / cancel admin user invitationput
    • Revoke an admin userdelete
    • Get the list of all admin usersget
    • Check admin user permissionsget
    • Change admin user permissionsput
    • Get the list of groupsget
  • User
    • Get the list of all your usersget
    • Check user permissionget
    • Revoke user permissionput
    • Resend / Cancel invitationput
    • Send invitation to userpost
    • Update permission for a userpost
  • Process
    • Return all the processes for your accountget
    • Return the informations for a processget
  • External Feeds
    • Fetch all external feedsget
    • Create an external feedpost
    • Get an external feed by UUIDget
    • Update an external feedput
    • Delete an external feeddelete

Sales CRM

  • Companies
    • Get all Companiesget
    • Create a companypost
    • Get a companyget
    • Delete a companydelete
    • Update a companypatch
    • Create a company/deal attributepost
    • Get company attributesget
    • Link and Unlink company with contact and dealpatch
    • Import companies(creation and updation)post
  • Deals
    • Get pipeline stagesget
    • Get a pipelineget
    • Get all pipelinesget
    • Get deal attributesget
    • Get all dealsget
    • Create a dealpost
    • Get a dealget
    • Delete a dealdelete
    • Update a dealpatch
    • Link and Unlink a deal with contacts and companiespatch
    • Import deals(creation and updation)post
  • Tasks
    • Get all task typesget
    • Get all tasksget
    • Create a taskpost
    • Get a taskget
    • Delete a taskdelete
    • Update a taskpatch
  • Notes
    • Get all notesget
    • Create a notepost
    • Get a noteget
    • Update a notepatch
    • Delete a notedelete
  • Files
    • Get all filesget
    • Upload a filepost
    • Download a fileget
    • Delete a filedelete
    • Get file detailsget

Brevo API

  • Conversations
    • Send a message as an agentpost
    • Get a messageget
    • Update a message sent by an agentput
    • Delete a message sent by an agentdelete
    • Send an automated message to a visitorpost
    • Get an automated messageget
    • Update an automated messageput
    • Delete an automated messagedelete
    • Sets agent’s status to online for 2-3 minutespost

Tracker

  • Restful endpoints
    • Identify the userpost
    • Track eventpost
    • Track link clickspost
    • Track page viewspost

Ecommerce

  • Ecommerce
    • Activate the eCommerce apppost
    • Set the ISO 4217 compliant display currency code for your Brevo accountpost
    • Get the ISO 4217 compliant display currency code for your Brevo accountget
    • Get attribution metrics for one or more Brevo campaigns or workflowsget
    • Get detailed attribution metrics for a single Brevo campaign or workflowget
    • Get attributed product sales for a single Brevo campaign or workflowget
    • Get order detailsget
    • Managing the status of the orderpost
    • Create orders in batchpost
    • Return all your categoriesget
    • Create/Update a categorypost
    • Get a category detailsget
    • Create categories in batchpost
    • Return all your productsget
    • Create/Update a productpost
    • Get a product's detailsget
    • Create products in batchpost
  • Coupons
    • Get all your coupon collectionsget
    • Create а coupon collectionpost
    • Get a coupon collection by idget
    • Update a coupon collection by idpatch
    • Create coupons for a coupon collectionpost
  • Payments
    • Create a payment requestpost
    • Get payment request detailsget
    • Delete a payment request.delete

Loyalty

  • Program
    • Get loyalty program listget
    • Create loyalty programpost
    • Get loyalty program Infoget
    • Update loyalty programput
    • Partially update loyalty programpatch
    • Delete Loyalty Programdelete
    • Publish loyalty programpost
    • Create subscriptionpost
    • Create subscription memberpost
    • Delete subscription memberdelete
    • Get Subscription Dataget
  • Reward
    • Get code countget
    • Get voucher for a contactget
    • Get Reward Page APIget
    • Create a rewardpost
    • Get reward informationget
    • Create a voucherpost
    • Create redeem voucher requestpost
    • Complete redeem voucher requestpost
    • Revoke vouchersdelete
    • Validate a rewardpost
  • Balance
    • Get balance definition listget
    • Create balance definitionpost
    • Get balance definitionget
    • Update balance definitionput
    • Delete balance definitiondelete
    • Create balance limitspost
    • Get balance limitsget
    • Delete balance limitdelete
    • Updates balance limitput
    • Get subscription balancesget
    • Create subscription balancespost
    • Get balance listget
    • Create new transactionpost
    • Complete transactionpost
    • Cancel transactionpost
    • Create balance orderpost
    • Get Active Balances APIget
    • Get Transaction History APIget
  • Tier
    • Create a tier grouppost
    • List tier groupsget
    • Update tier groupput
    • Delete tier groupdelete
    • Get tier groupget
    • List tiersget
    • Create a tierpost
    • Delete tierdelete
    • Update tierput
    • Assign a tierpost