How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Brevo Transactional Emails API

The transactionalEmails API from Brevo — 18 operation(s) for transactionalemails.

Brevo Transactional Emails API is one of 53 APIs that Brevo publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Transactional Emails. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 22 operations across 18 paths, and defines 98 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.brevo.com/v3.

22 operations 18 paths 98 schemas 5 DELETE10 GET6 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.brevo.com/v3
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Brevo Transactional Emails API declares 1 security scheme for authenticating requests. An API key is passed in the header as api-key (api-key).

  • api-key — The API key should be passed in the request headers as api-key for authentication.

Paths & Operations 22

Across 18 paths, the API surfaces 22 operations — 5 DELETE, 10 GET, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

transactionalEmails 22
POST
/smtp/email
Send a transactional email
sendTransacEmail 1 param body → 201400
GET
/smtp/emails
Get the list of transactional emails on the basis of allowed filters
getTransacEmailsList 9 params → 200400
GET
/smtp/emails/{uuid}
Get the personalized content of a sent transactional email
getTransacEmailContent 2 params → 200400404
DELETE
/smtp/email/{identifier}
Delete scheduled emails by batchId or messageId
deleteScheduledEmailById 2 params → 204400404
GET
/smtp/emailStatus/{identifier}
Fetch scheduled emails by batchId or messageId
getScheduledEmailById 8 params → 200400404
POST
/smtp/deleteHardbounces
Delete hardbounces
deleteHardbounces 1 param body → 200400
GET
/smtp/statistics/reports
Get your transactional email activity aggregated per day
getSmtpReport 8 params → 200400
GET
/smtp/statistics/events
Get all your transactional email activity (unaggregated events)
getEmailEventReport 12 params → 200400
GET
/smtp/statistics/aggregatedReport
Get your transactional email activity aggregated over a period of time
getAggregatedSmtpReport 5 params → 200400
DELETE
/smtp/log/{identifier}
Delete an SMTP transactional log
deleteAnSmtpTransactionalLog 4 params → 204400404
GET
/smtp/templates
Get the list of email templates
getSmtpTemplates 6 params → 200400
POST
/smtp/templates
Create an email template
createSmtpTemplate 1 param body → 201400
DELETE
/smtp/templates/{templateId}
Delete an inactive email template
deleteSmtpTemplate 2 params → 204400404
PUT
/smtp/templates/{templateId}
Update an email template
updateSmtpTemplate 2 params body → 204400404
GET
/smtp/templates/{templateId}
Returns the template information
getSmtpTemplate 2 params → 200400404
POST
/smtp/templates/{templateId}/sendTest
Send a template to your test list
sendTestTemplate 2 params body → 204400404
POST
/smtp/template/preview
Generate the rendered preview of transactional template
postPreviewSmtpEmailTemplates 1 param body → 200400
GET
/smtp/blockedContacts
Get the list of blocked or unsubscribed transactional contacts
getTransacBlockedContacts 7 params → 200400
DELETE
/smtp/blockedContacts/{email}
Unblock or resubscribe a transactional contact
unblockOrResubscribeATransactionalContact 2 params → 204400404
POST
/smtp/blockedDomains
Add a new domain to the list of blocked domains
blockNewDomain 1 param body → 201400
GET
/smtp/blockedDomains
Get the list of blocked domains
getBlockedDomains 1 param → 200400
DELETE
/smtp/blockedDomains/{domain}
Unblock an existing domain from the list of blocked domains
deleteBlockedDomain 2 params → 204400404

Schemas 98

The contract defines 98 schemas that model the data the API accepts and returns. The most detailed are getSmtpTemplateOverview (14 properties), Transactional_emails_getAggregatedSmtpReport_Response_200 (13 properties), SmtpStatisticsReportsGetResponsesContentApplicationJsonSchemaReportsItems (13 properties), SmtpStatisticsEventsGetResponsesContentApplicationJsonSchemaEventsItems (11 properties). Each schema is shown below with its type and property counts.

GetTransacBlockedContactsRequestBadRequestError
object
2 properties 2 required
SmtpTemplatesTemplateIdDeleteResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
Transactional_emails_getTransacBlockedContacts_Response_200
object
2 properties
GetTransacEmailContentRequestBadRequestError
object
2 properties 2 required
Transactional_emails_getTransacEmailsList_Response_200
object
2 properties
SmtpStatisticsAggregatedReportGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
SmtpTemplatesTemplateIdPutParametersTemplateId
SmtpEmailsGetResponsesContentApplicationJsonSchemaTransactionalEmailsItems
object
8 properties 5 required
Transactional_emails_postPreviewSmtpEmailTemplates_Response_200
object
6 properties
SmtpEmailPostRequestBodyContentApplicationJsonSchemaMessageVersionsItemsBccItems
object
3 properties 1 required
SmtpTemplatePreviewPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
SmtpTemplatesTemplateIdPutResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
SmtpBlockedDomainsDomainDeleteResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
SmtpEmailPostRequestBodyContentApplicationJsonSchemaMessageVersionsItemsCcItems
object
3 properties 1 required
SmtpStatisticsEventsGetResponsesContentApplicationJsonSchemaEventsItems
object
11 properties 4 required
SmtpEmailsGetParametersSort
string
SmtpEmailPostRequestBodyContentApplicationJsonSchemaToItems
object
3 properties 1 required
DeleteScheduledEmailByIdRequestBadRequestError
object
2 properties 2 required
GetAggregatedSmtpReportRequestBadRequestError
object
2 properties 2 required
Transactional_emails_getEmailEventReport_Response_200
object
1 property
GetScheduledEmailByIdRequestNotFoundError
object
2 properties 2 required
SmtpEmailPostRequestBodyContentApplicationJsonSchemaBccItems
object
3 properties 1 required
SmtpTemplatesGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
DeleteScheduledEmailByIdRequestNotFoundError
object
2 properties 2 required
SmtpEmailPostRequestBodyContentApplicationJsonSchemaSender
object
Sender information. Required when templateId is not provided. Specify either an email address (with optional name) or a sender ID. The name field is ignored wh…
3 properties
PostPreviewSmtpEmailTemplatesRequestBadRequestError
object
2 properties 2 required
DeleteBlockedDomainRequestBadRequestError
object
2 properties 2 required
DeleteAnSmtpTransactionalLogRequestBadRequestError
object
2 properties 2 required
GetTransacEmailsListRequestBadRequestError
object
2 properties 2 required
SmtpEmailPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
SmtpStatisticsEventsGetParametersSort
string
SendTransacEmailRequestBadRequestError
object
2 properties 2 required
SmtpLogIdentifierDeleteResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
SmtpStatisticsEventsGetResponsesContentApplicationJsonSchemaEventsItemsEvent
string
Event which occurred
Transactional_emails_blockNewDomain_Response_201
object
Empty response body
UnblockOrResubscribeATransactionalContactRequestNotFoundError
object
2 properties 2 required
errorModel
object
2 properties 1 required
SmtpBlockedDomainsPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
DeleteSmtpTemplateRequestBadRequestError
object
2 properties 2 required
SmtpBlockedContactsGetParametersSort
string
DeleteHardbouncesRequestBadRequestError
object
2 properties 2 required
postSendFailed
object
5 properties 2 required
SmtpEmailStatusIdentifierGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
SmtpEmailStatusIdentifierGetParametersStatus
string
SmtpEmailsUuidGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
SmtpStatisticsEventsGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
SmtpDeleteHardbouncesPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
GetBlockedDomainsRequestBadRequestError
object
2 properties 2 required
BlockNewDomainRequestBadRequestError
object
2 properties 2 required
GetSmtpReportRequestBadRequestError
object
2 properties 2 required
SmtpTemplatesGetParametersSort
string
SmtpEmailsGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
SmtpTemplatesPostRequestBodyContentApplicationJsonSchemaSender
object
Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For exampl…
3 properties
SmtpTemplatesTemplateIdPutRequestBodyContentApplicationJsonSchemaSender
object
Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For exampl…
3 properties
SmtpEmailIdentifierDeleteResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
SmtpBlockedContactsGetResponsesContentApplicationJsonSchemaContactsItemsReasonCode
string
Reason code for blocking / unsubscribing (This code is safe for comparison)
SmtpEmailPostRequestBodyContentApplicationJsonSchemaMessageVersionsItems
object
8 properties 1 required
SmtpEmailPostRequestBodyContentApplicationJsonSchemaMessageVersionsItemsReplyTo
object
Reply-to email address (required) and optional display name. Recipients will use this address when replying to the email.
2 properties 1 required
Transactional_emails_postPreviewSmtpEmailTemplates_Request
UnblockOrResubscribeATransactionalContactRequestBadRequestError
object
2 properties 2 required
Transactional_emails_getBlockedDomains_Response_200
object
1 property 1 required
SmtpEmailPostRequestBodyContentApplicationJsonSchemaAttachmentItems
object
3 properties
SmtpTemplatesTemplateIdGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
CreateSmtpTemplateRequestBadRequestError
object
2 properties 2 required
GetSmtpTemplatesRequestBadRequestError
object
2 properties 2 required
SmtpTemplatesTemplateIdGetParametersTemplateId
SmtpEmailsUuidGetResponsesContentApplicationJsonSchemaEventsItems
object
2 properties 2 required
SmtpStatisticsReportsGetResponsesContentApplicationJsonSchemaReportsItems
object
13 properties 13 required
Transactional_emails_getAggregatedSmtpReport_Response_200
object
13 properties
UpdateSmtpTemplateRequestBadRequestError
object
2 properties 2 required
SmtpTemplatesPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
SmtpEmailPostRequestBodyContentApplicationJsonSchemaMessageVersionsItemsToItems
object
3 properties 1 required
SmtpBlockedContactsGetResponsesContentApplicationJsonSchemaContactsItems
object
4 properties 4 required
Transactional_emails_createSmtpTemplate_Response_201
object
1 property 1 required
GetSmtpTemplateOverviewSender
object
3 properties
Transactional_emails_getTransacEmailContent_Response_200
object
7 properties 4 required
Transactional_emails_getScheduledEmailById_Response_200
GetSmtpTemplateRequestBadRequestError
object
2 properties 2 required
SmtpStatisticsReportsGetParametersSort
string
Transactional_emails_deleteHardbounces_Response_200
object
Empty response body
SmtpStatisticsEventsGetParametersEvent
string
SmtpBlockedContactsGetResponsesContentApplicationJsonSchemaContactsItemsReason
object
Reason for blocking / unsubscribing
2 properties
SmtpTemplatesGetParametersEditorType
string
GetTransacEmailContentRequestNotFoundError
object
2 properties 2 required
SmtpBlockedContactsEmailDeleteResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
SmtpStatisticsReportsGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
GetScheduledEmailByIdRequestBadRequestError
object
2 properties 2 required
Transactional_emails_getSmtpTemplates_Response_200
object
2 properties
sendTestEmail
object
1 property
SmtpEmailPostRequestBodyContentApplicationJsonSchemaReplyTo
object
Reply-to email address (required) and optional display name. Recipients will use this address when replying to the email.
2 properties 1 required
SmtpBlockedContactsGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
Transactional_emails_getSmtpReport_Response_200
object
1 property
SmtpEmailPostRequestBodyContentApplicationJsonSchemaCcItems
object
3 properties 1 required
SmtpEmailStatusIdentifierGetParametersSort
string
GetEmailEventReportRequestBadRequestError
object
2 properties 2 required
SmtpBlockedDomainsGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
getSmtpTemplateOverview
object
14 properties 12 required
Transactional_emails_sendTransacEmail_Response_201
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

brevo-transactionalemails-api-openapi.yml Raw ↑

Other APIs Brevo publishes across the network.

brevo Agent Status API
brevo Automated Messages API
brevo Campaign Statistics API
brevo Categories API
brevo Contact Attributes API
brevo Contact Lists API
brevo Contacts API
brevo Email Activity API
brevo Email Campaigns API
brevo Email Templates API
brevo Folders API
brevo Import API
Where this information came from

This is an independent, third-party profile of Brevo Transactional Emails API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.