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

SendPulse Campaigns API

Endpoints related to Campaigns.

SendPulse Campaigns API is one of 85 APIs that SendPulse publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 24 operations across 19 paths, and defines 16 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 7 base URLs: https://api.sendpulse.com, https://api.sendpulse.com/messenger, https://api.sendpulse.com/instagram, https://api.sendpulse.com/telegram, https://api.sendpulse.com/tiktok, https://api.sendpulse.com/viber/chatbots, https://api.sendpulse.com/whatsapp.

24 operations 19 paths 16 schemas 2 DELETE13 GET1 PATCH7 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.sendpulse.com
Authentication
HTTP Bearer, OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 3

SendPulse Campaigns API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (API Key) (apiKey). It supports OAuth 2.0 (oauth2) using the clientCredentials flow. It supports OAuth 2.0 (outh2) using the clientCredentials flow. By default, every request must be authenticated.

  • apiKey — Static API Key authentication. A long-lived token generated manually in the SendPulse account settings.
  • oauth2 — OAuth 2.0 Client Credentials flow for temporary access tokens.
  • outh2 — OAuth 2.0 Client Credentials flow for temporary access tokens.

Paths & Operations 24

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

Campaigns 24

Endpoints related to Campaigns.

POST
/campaigns
Create a campaign
createCampaign body → 200401403
GET
/campaigns
Get a list of campaigns
getCampaigns 5 params → 200401403
GET
/campaigns/{id}
Get campaign information
getCampaignById 1 param → 200401403
PATCH
/campaigns/{id}
Edit scheduled campaign
updateCampaign 1 param body → 200401403
DELETE
/campaigns/{id}
Cancel a campaign
cancelCampaign 1 param → 200401403
GET
/campaigns/{id}/countries
Get country statistics
getCampaignCountryStats 1 param → 200401403
GET
/campaigns/{id}/referrals
Get referrals statistics
getCampaignReferralStats 1 param → 200401403
GET
/addressbooks/{id}/campaigns
Get campaigns by mailing list
getCampaignsByList 3 params → 200401403404
POST
/campaigns/send
Send campaign
sendCampaign body → 200
POST
/sms/campaigns
Create a campaign for a mailing list
createSmsCampaign body → 200401403
DELETE
/sms/campaigns
Delete a campaign
deleteSmsCampaign body → 200401403
POST
/sms/send
Create a campaign for a list of phone numbers
sendSmsToNumbers body → 200401403
GET
/sms/campaigns/list
Get a list of campaigns by date
getSmsCampaigns 2 params → 200401403
GET
/sms/campaigns/info/{id}
Get campaign information
getSmsCampaignInfo 1 param → 200401403
PUT
/sms/campaigns/cancel/{id}
Cancel a campaign before sending has started
cancelSmsCampaign 1 param → 200401403
GET
/sms/campaigns/cost
Calculate the cost of a campaign
calculateSmsCost 5 params → 200401403
POST
/viber
Create a Viber campaign
createViberCampaign body → 200401403
GET
/viber/task
Get a list of campaigns
getViberCampaigns 2 params → 200401403
GET
/viber/task/{id}
Get statistics on a campaign
getViberCampaignStats 1 param → 200401403
GET
/viber/task/{id}/recipients
Get a list of Viber campaign recipients
getViberRecipients 1 param → 200401403
GET
/push/tasks
Get a list of sent web push campaigns
getWebPushCampaigns 5 params → 200401403
POST
/push/tasks
Create a new web push campaign
createWebPushCampaign body → 200401403
GET
/push/tasks/{id}
Get statistics on sent campaigns
getWebPushCampaignStats 1 param → 200401403
POST
/campaigns/sendTemplate
Send a campaign by template
sendTemplateCampaign body → 200

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are CampaignCreateRequest (16 properties), Campaign (8 properties), ViberCampaign (7 properties), Campaign_6 (7 properties). Each schema is shown below with its type and property counts.

CampaignByListSummary
object
1 property
ResultTrue
object
1 property
CampaignUpdateRequest
object
2 properties
ResultTrueWithId
object
2 properties
CampaignDetails
object
3 properties
CampaignSummary
object
3 properties
ReferralStat
object
2 properties
CampaignCreateResponse
object
6 properties
CampaignCreateRequest
object
16 properties 3 required
Campaign
object
8 properties
Campaign_2
object
6 properties
Campaign_3
object
6 properties
Campaign_4
object
6 properties
Campaign_5
object
6 properties
ViberCampaign
object
7 properties
Campaign_6
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sendpulse-campaigns-api-openapi.yml Raw ↑

Other APIs SendPulse publishes across the network.

SendPulse Account API
SendPulse Attachments API
SendPulse Automation Flows API
SendPulse Balance API
SendPulse Blacklist API
SendPulse Board attributes API
SendPulse Bots API
SendPulse Bounces API
SendPulse Chats API
SendPulse Checklist Items API
SendPulse Company API
SendPulse Company Attributes API
Where this information came from

This is an independent, third-party profile of SendPulse 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.