Brevo Email Campaigns 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 Email Campaigns. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.
This API exposes
13 operations
across 10 paths,
and defines 84 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.
The identity and technical contract details declared by the specification.
EmailCampaignsGetResponsesContentApplicationJsonSchemaCampaignsItemsEmailExpirationDateUnit
string
Unit of the duration
EmailCampaignsPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
EmailCampaignsGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
Email_Campaigns_getSharedTemplateUrl_Response_200
object
1 property
1 required
EmailExportRecipientsRequestBadRequestError
object
2 properties
2 required
EmailCampaignsCampaignIdExportRecipientsPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
EmailCampaignsCampaignIdPutRequestBodyContentApplicationJsonSchemaEmailExpirationDate
object
To reduce your carbon footprint, set an expiration date for your email. If supported, it will be automatically deleted from the recipient’s inbox, saving stora…
2 properties
EmailCampaignsCampaignIdSendReportPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
EmailCampaignsCampaignIdAbTestCampaignResultGetResponsesContentApplicationJsonSchemaWinningVersion
string
Winning Campaign Info. pending = Campaign has been picked for sending and winning version is yet to be decided, tie = A tie happened between both the versions,…
GetAbTestCampaignResultRequestBadRequestError
object
2 properties
2 required
EmailCampaignsGetParametersSort
string
EmailCampaignsCampaignIdDeleteResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
UpdateCampaignStatusRequestBadRequestError
object
2 properties
2 required
Email_Campaigns_getAbTestCampaignResult_Response_200
object
8 properties
AbTestVersionClicksItems
object
3 properties
3 required
EmailCampaignsGetResponsesContentApplicationJsonSchemaCampaignsItemsType
string
Type of campaign
Email_Campaigns_getEmailCampaign_Response_200
object
42 properties
14 required
updateCampaignStatus
object
Status of the campaign
1 property
GetSharedTemplateUrlRequestBadRequestError
object
2 properties
2 required
EmailCampaignsPostRequestBodyContentApplicationJsonSchemaRecipients
object
Segment ids and List ids to include/exclude from campaign
4 properties
EmailCampaignsGetResponsesContentApplicationJsonSchemaCampaignsItemsStatus
string
Status of the campaign
EmailCampaignsCampaignIdStatusPutResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
EmailCampaignsCampaignIdGetResponsesContentApplicationJsonSchemaEmailExpirationDate
object
Expiration date configuration for the email campaign, if set. Contains the duration and unit of the email expiry.
2 properties
EmailCampaignsCampaignIdPutRequestBodyContentApplicationJsonSchemaRecipients
object
Segment ids and List ids to include/exclude from campaign
4 properties
EmailCampaignsGetResponsesContentApplicationJsonSchemaCampaignsItemsSender
object
3 properties
Email_Campaigns_emailExportRecipients_Response_202
object
1 property
1 required
EmailCampaignsCampaignIdAbTestCampaignResultGetResponsesContentApplicationJsonSchemaClickedLinks
object
2 properties
2 required
EmailCampaignsCampaignIdGetResponsesContentApplicationJsonSchemaEmailExpirationDateUnit
string
Unit of the duration
EmailCampaignsCampaignIdAbTestCampaignResultGetResponsesContentApplicationJsonSchemaStatistics
object
6 properties
6 required
EmailCampaignsCampaignIdGetParametersStatistics
string
EmailCampaignsCampaignIdPutRequestBodyContentApplicationJsonSchemaEmailExpirationDateUnit
string
unit of the duration
UpdateCampaignStatusRequestNotFoundError
object
2 properties
2 required
EmailCampaignsGetResponsesContentApplicationJsonSchemaCampaignsItemsEmailExpirationDate
object
Expiration date configuration for the email campaign, if set. Contains the duration and unit of the email expiry.
2 properties
getCampaignRecipients
object
4 properties
2 required
errorModel
object
2 properties
1 required
EmailCampaignsPostRequestBodyContentApplicationJsonSchemaEmailExpirationDate
object
To reduce your carbon footprint, set an expiration date for your email. If supported, it will be automatically deleted from the recipient’s inbox, saving stora…
2 properties
EmailCampaignsCampaignIdGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
EmailCampaignsCampaignIdAbTestCampaignResultGetResponsesContentApplicationJsonSchemaWinningCriteria
string
Criteria chosen for winning version (Open/Click)
GetEmailCampaignRequestNotFoundError
object
2 properties
2 required
UpdateEmailCampaignRequestNotFoundError
object
2 properties
2 required
postSendFailed
object
5 properties
2 required
SendReportEmail
object
Custom attributes for the report email.
2 properties
2 required
sendReport
object
2 properties
1 required
EmailCampaignsCampaignIdSendNowPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
SendReportRequestBadRequestError
object
2 properties
2 required
Email_Campaigns_createEmailCampaign_Response_201
object
1 property
1 required
EmailCampaignsCampaignIdPutResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
EmailCampaignsCampaignIdExportRecipientsPostRequestBodyContentApplicationJsonSchemaRecipientsType
string
Type of recipients to export for a campaign
getCampaignStats
object
18 properties
13 required
EmailCampaignsCampaignIdGetResponsesContentApplicationJsonSchemaSender
object
3 properties
CreateEmailCampaignRequestBadRequestError
object
2 properties
2 required
EmailCampaignsCampaignIdGetResponsesContentApplicationJsonSchemaStatus
string
Status of the campaign
EmailCampaignsCampaignIdGetResponsesContentApplicationJsonSchemaType
string
Type of campaign
DeleteEmailCampaignRequestBadRequestError
object
2 properties
2 required
EmailExportRecipientsRequestNotFoundError
object
2 properties
2 required
EmailCampaignsPostRequestBodyContentApplicationJsonSchemaEmailExpirationDateUnit
string
unit of the duration
SendReportLanguage
string
Language of email content for campaign report sending.
Email_Campaigns_getEmailCampaigns_Response_200
object
2 properties
getDeviceBrowserStats
object
4 properties
4 required
abTestVersionClicks
array
Information on clicked links for a particular version
EmailCampaignsCampaignIdPutRequestBodyContentApplicationJsonSchemaWinnerCriteria
string
Choose the metrics that will determinate the winning version. Mandatory if splitRule = 1 and < 50. If splitRule = 50, winnerCriteria is ignored if passed
EmailCampaignsPostRequestBodyContentApplicationJsonSchemaSender
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. Passing bo…
3 properties
SendEmailCampaignNowRequestNotFoundError
object
2 properties
2 required
EmailCampaignsImagesPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
abTestVersionStats
object
Percentage of a particular event for both versions
2 properties
2 required
EmailCampaignsCampaignIdSharedUrlGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
EmailCampaignsGetParametersStatus
string
Email_Campaigns_uploadImageToGallery_Response_201
object
1 property
GetEmailCampaignsRequestBadRequestError
object
2 properties
2 required
UploadImageToGalleryRequestBadRequestError
object
2 properties
2 required
EmailCampaignsPostRequestBodyContentApplicationJsonSchemaWinnerCriteria
string
Choose the metrics that will determinate the winning version. Mandatory if splitRule = 1 and < 50. If splitRule = 50, winnerCriteria is ignored if passed
getExtendedCampaignStats
object
8 properties
5 required
EmailCampaignsCampaignIdPutRequestBodyContentApplicationJsonSchemaSender
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
EmailCampaignsGetParametersType
string
EmailCampaignsGetResponsesContentApplicationJsonSchemaCampaignsItems
object
42 properties
14 required
sendTestEmail
object
1 property
UpdateCampaignStatusStatus
string
Note:- replicateTemplate status will be available only for template type campaigns.
UpdateEmailCampaignRequestBadRequestError
object
2 properties
2 required
SendReportRequestNotFoundError
object
2 properties
2 required
GetExtendedCampaignStatsStatsByDevice
object
4 properties
DeleteEmailCampaignRequestNotFoundError
object
2 properties
2 required
EmailCampaignsCampaignIdAbTestCampaignResultGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
EmailCampaignsGetParametersStatistics
string
GetEmailCampaignRequestBadRequestError
object
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Brevo publishes across the network.
