The identity and technical contract details declared by the specification.
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
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Brevo publishes across the network.