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 Sms Campaigns API

The smsCampaigns API from Brevo — 7 operation(s) for smscampaigns.

Brevo Sms 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 SMS Campaigns. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 10 operations across 7 paths, and defines 50 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.

10 operations 7 paths 50 schemas 1 DELETE2 GET5 POST2 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 Sms Campaigns 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 10

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

smsCampaigns 10
GET
/smsCampaigns
Returns the information for all your created SMS campaigns
getSmsCampaigns 7 params → 200400
POST
/smsCampaigns
Creates an SMS campaign
createSmsCampaign 1 param body → 201400
GET
/smsCampaigns/{campaignId}
Get an SMS campaign
getSmsCampaign 2 params → 200400404
PUT
/smsCampaigns/{campaignId}
Update an SMS campaign
updateSmsCampaign 2 params body → 204400404
DELETE
/smsCampaigns/{campaignId}
Delete an SMS campaign
deleteSmsCampaign 2 params → 204400404
POST
/smsCampaigns/{campaignId}/sendNow
Send your SMS campaign immediately
sendSmsCampaignNow 2 params → 204400402404
PUT
/smsCampaigns/{campaignId}/status
Update a campaign's status
updateSmsCampaignStatus 2 params body → 204400404
POST
/smsCampaigns/{campaignId}/sendTest
Send a test SMS campaign
sendTestSms 2 params body → 204400404
POST
/smsCampaigns/{campaignId}/exportRecipients
Export an SMS campaign's recipients
requestSmsRecipientExport 2 params body → 202400404
POST
/smsCampaigns/{campaignId}/sendReport
Send an SMS campaign's report
sendSmsReport 2 params body → 204400404

Schemas 50

The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are SMS_Campaigns_getSmsCampaign_Response_200 (14 properties), SmsCampaignsGetResponsesContentApplicationJsonSchemaCampaignsItems (13 properties), getSmsCampaignStats (7 properties), getCampaignRecipients (4 properties). Each schema is shown below with its type and property counts.

SendReportEmail
object
Custom attributes for the report email.
2 properties 2 required
sendReport
object
2 properties 1 required
SmsCampaignsCampaignIdSendTestPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
SmsCampaignsPostRequestBodyContentApplicationJsonSchemaRecipients
object
2 properties 1 required
SmsCampaignsGetParametersSort
string
SmsCampaignsCampaignIdGetResponsesContentApplicationJsonSchemaStatus
string
Status of the SMS Campaign
SMS_Campaigns_createSmsCampaign_Response_201
object
1 property 1 required
SendTestSmsRequestBadRequestError
object
4 properties 2 required
SmsCampaignsCampaignIdPutResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
DeleteSmsCampaignRequestBadRequestError
object
2 properties 2 required
SendSmsCampaignNowRequestNotFoundError
object
2 properties 2 required
SMS_Campaigns_getSmsCampaigns_Response_200
object
2 properties
UpdateSmsCampaignRequestBadRequestError
object
2 properties 2 required
SendSmsReportRequestNotFoundError
object
2 properties 2 required
GetSmsCampaignsRequestBadRequestError
object
2 properties 2 required
SmsCampaignsGetResponsesContentApplicationJsonSchemaCampaignsItemsStatus
string
Status of the SMS Campaign
SmsCampaignsGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
SmsCampaignsPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
RequestSmsRecipientExportRequestNotFoundError
object
2 properties 2 required
RequestSmsRecipientExportRequestBadRequestError
object
2 properties 2 required
GetSmsCampaignRequestBadRequestError
object
2 properties 2 required
SmsCampaignsCampaignIdGetResponsesContentApplicationJsonSchemaRecipientsExclusionListsItems
object
2 properties
DeleteSmsCampaignRequestNotFoundError
object
2 properties 2 required
SmsCampaignsCampaignIdGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
SmsCampaignsCampaignIdExportRecipientsPostRequestBodyContentApplicationJsonSchemaRecipientsType
string
Filter the recipients based on how they interacted with the campaign
SmsCampaignsCampaignIdExportRecipientsPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
SmsCampaignsCampaignIdSendNowPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
SMS_Campaigns_getSmsCampaign_Response_200
object
14 properties 9 required
UpdateSmsCampaignRequestNotFoundError
object
2 properties 2 required
SmsCampaignsCampaignIdPutRequestBodyContentApplicationJsonSchemaRecipients
object
2 properties 1 required
SmsCampaignsCampaignIdDeleteResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
GetSmsCampaignRequestNotFoundError
object
2 properties 2 required
SendSmsReportRequestBadRequestError
object
2 properties 2 required
SmsCampaignsCampaignIdStatusPutResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
UpdateCampaignStatusStatus
string
Note:- replicateTemplate status will be available only for template type campaigns.
UpdateSmsCampaignStatusRequestBadRequestError
object
2 properties 2 required
getCampaignRecipients
object
4 properties 2 required
CreateSmsCampaignRequestBadRequestError
object
2 properties 2 required
updateCampaignStatus
object
Status of the campaign
1 property
SendTestSmsRequestNotFoundError
object
2 properties 2 required
errorModel
object
2 properties 1 required
getSmsCampaignStats
object
7 properties 7 required
SendReportLanguage
string
Language of email content for campaign report sending.
SmsCampaignsGetParametersStatus
string
SmsCampaignsCampaignIdGetResponsesContentApplicationJsonSchemaRecipients
object
Recipients of the SMS campaign. For a single campaign, lists and exclusion lists are returned as objects with id and name.
2 properties
SMS_Campaigns_requestSmsRecipientExport_Response_202
object
1 property 1 required
SmsCampaignsCampaignIdGetResponsesContentApplicationJsonSchemaRecipientsListsItems
object
2 properties
SmsCampaignsGetResponsesContentApplicationJsonSchemaCampaignsItems
object
13 properties 9 required
UpdateSmsCampaignStatusRequestNotFoundError
object
2 properties 2 required
SmsCampaignsCampaignIdSendReportPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

brevo-smscampaigns-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 Sms Campaigns 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.