Brevo

Email API

Connection for brevo CRM suite

Developer tools#data-validation

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Connection for brevo CRM suite

Endpoints 25

transactionalEmails

  • POSTSend a transactional email/smtp/emailSend a transactional email to one or more recipients, either using inline HTML content or a pre-built template via templateId. You can schedule emails for…
  • GETGet the list of transactional emails on the basis of allowed filters/smtp/emailsThis endpoint will show the list of emails for past 30 days by default. To retrieve emails before that time, please pass startDate and endDate in query filters.
  • GETGet the personalized content of a sent transactional email/smtp/emails/:uuid<Note title="How to get uuid">You can get the uuid using either of the following methods: Send a GET request to https://api.brevo.com/v3/smtp/emails and pass…
  • DELETEDelete scheduled emails by batchId or messageId/smtp/email/:identifierDelete scheduled batch of emails by batchId or single scheduled email by messageId
  • GETFetch scheduled emails by batchId or messageId/smtp/emailStatus/:identifierFetch scheduled batch of emails by batchId or single scheduled email by messageId (Can retrieve data upto 30 days old)
  • POSTDelete hardbounces/smtp/deleteHardbouncesDelete hardbounces. To use carefully (e.g. in case of temporary ISP failures)
  • GETGet your transactional email activity aggregated per day/smtp/statistics/reportsThis endpoint will show the aggregated stats per day for the past 10 days by default if startDate and endDate OR days is not passed. The date range can not…
  • GETGet all your transactional email activity (unaggregated events)/smtp/statistics/eventsThis endpoint will show the aggregated stats for past 30 days by default if startDate and endDate OR days is not passed. The date range can not exceed 90 days
  • GETGet your transactional email activity aggregated over a period of time/smtp/statistics/aggregatedReportThis endpoint will show the aggregated stats for past 90 days by default if startDate and endDate OR days is not passed. The date range can not exceed 90 days
  • DELETEDelete an SMTP transactional log/smtp/log/:identifierDelete SMTP transactional log entries identified by a message ID (enclosed in angle brackets with an @ sign) or a valid email address. Optionally narrow the…
  • GETGet the list of email templates/smtp/templatesRetrieve a paginated list of all transactional email templates (including automation templates) with their details such as name, subject, sender, status, HTML…
  • POSTCreate an email template/smtp/templatesCreate a new transactional email template with the specified sender, subject, and content. The sender, subject, and templateName fields are required. Template…
  • GETReturns the template information/smtp/templates/:templateIdRetrieve the full details of a specific transactional email template by its numeric ID or custom template identifier string. The response includes the…
  • PUTUpdate an email template/smtp/templates/:templateIdUpdate an existing transactional email template by its numeric ID or custom template identifier string. All fields in the request body are optional; only the…
  • DELETEDelete an inactive email template/smtp/templates/:templateIdPermanently delete a transactional email template by its numeric ID. Only inactive templates can be deleted; attempting to delete an active template returns a…
  • POSTSend a template to your test list/smtp/templates/:templateId/sendTestSend a test email of the specified transactional template to one or more recipients. Provide an array of email addresses in the emailTo field; if left empty,…
  • POSTGenerate the rendered preview of transactional template/smtp/template/previewGenerate a fully rendered preview of a transactional email template by resolving dynamic variables. Provide either an email address (to populate variables…
  • GETGet the list of blocked or unsubscribed transactional contacts/smtp/blockedContactsRetrieve a paginated list of transactional contacts that have been blocked or unsubscribed, along with the reason for blocking (e.g. hard bounce, admin…
  • DELETEUnblock or resubscribe a transactional contact/smtp/blockedContacts/:emailUnblock or resubscribe a transactional contact by removing their email address from the blacklist. The email address must be URL-encoded in the path parameter…
  • GETGet the list of blocked domains/smtp/blockedDomainsGet the list of blocked domains
  • POSTAdd a new domain to the list of blocked domains/smtp/blockedDomainsBlocks a new domain in order to avoid messages being sent to the same
  • DELETEUnblock an existing domain from the list of blocked domains/smtp/blockedDomains/:domainUnblocks an existing domain from the list of blocked domains

inboundParsing

  • GETGet the list of all the events for the received emails./inbound/eventsThis endpoint will show the list of all the events for the received emails. When no date range is provided, the last 30 days of events are returned by default.
  • GETFetch all events history for one particular received email./inbound/events/:uuidThis endpoint will show the list of all events history for one particular received email.
  • GETRetrieve inbound attachment with download token./inbound/attachments/:downloadTokenThis endpoint will retrieve inbound attachment with download token.

API details

Base URL
https://api.brevo.com/v3
Authentication
An API key in the api-key header
A bearer token in the Authorization header
Operations
25 operations on 21 pathsGET 13POST 6DELETE 5PUT 1
Main resources
transactionalEmails 22inboundParsing 3
Response formats
application/json application/octet-stream
Description format
OpenAPI 3.1.0, API version 1.0.0

How to test the Email API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Email API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the api-key header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Send a transactional email” (POST /smtp/email), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Email API?

Connection for brevo CRM suite It is listed under Developer tools and has 25 endpoints.

Who publishes the Email API?

It is listed from Brevo's public API description (an OpenAPI document), not published by Brevo on Swastik Codes. Anyone who controls brevo.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Email API?

Requests go to https://api.brevo.com/v3. Endpoint paths are added to this base URL.

How do I authenticate with the Email API?

It accepts 2 methods: an API key in the api-key header; A bearer token in the Authorization header.

How many endpoints does the Email API have?

25 operations on 21 paths (13 GET, 6 POST, 5 DELETE, 1 PUT). The largest groups are transactionalEmails, inboundParsing.

Is forking the Email API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.