SendPulse

SendPulse Campaigns API

Endpoints related to Campaigns.

GitHub OpenAPI
Business capability
Digital Marketing Management BC-400.60

Operations 24

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /campaigns Create and send or schedule an email campaign · Create a campaign #
Ask an LLM
“How do I send an email campaign to one of my mailing lists?”
“Can I schedule an email newsletter to go out at a specific date and time?”
Tell an agent
Send an email campaign with subject {subject} from {sender_email} to mailing list {list_id} using template {template_id}.
Schedule an email campaign named {name} from {sender_name} with subject {subject} for {send_date}.
GET /campaigns List email campaigns and their status · Get a list of campaigns #
Ask an LLM
“Where can I see the history and status of all my SendPulse email campaigns?”
“Can I list only the email campaigns that are still scheduled to go out?”
Tell an agent
List all my email campaigns with their delivery status.
Show my email campaigns with status {status}, {limit} at a time.
GET /campaigns/{id} Get details and stats for one email campaign · Get campaign information #
Ask an LLM
“What are the open and delivery stats for a specific email campaign?”
“Can I look up the details of one email campaign by its ID?”
Tell an agent
Show the details and stats of email campaign {id}.
How did email campaign {id} perform; pull its numbers
PATCH /campaigns/{id} Edit a scheduled email campaign's name or subject · Edit scheduled campaign #
Ask an LLM
“Can I change the subject line of an email campaign that is still scheduled?”
“Is it possible to rename a pending email campaign?”
Tell an agent
Change the subject of scheduled email campaign {id} to {subject}.
Rename pending email campaign {id} to {name}.
DELETE /campaigns/{id} Cancel a pending email campaign · Cancel a campaign #
Ask an LLM
“Can I stop an email campaign that is already pending or processing?”
“How do I cancel a scheduled email newsletter before it goes out?”
Tell an agent destructive · confirm first
Cancel email campaign {id}.
Stop the pending email send for campaign {id} right now.
GET /campaigns/{id}/countries Break down email campaign opens by country · Get country statistics #
Ask an LLM
“Which countries opened my email campaign the most?”
“Can I see a geographic breakdown of opens for a campaign?”
Tell an agent
Show the opens by country for email campaign {id}.
Break down where readers of campaign {id} were located.
GET /campaigns/{id}/referrals Break down link clicks in an email campaign · Get referrals statistics #
Ask an LLM
“Which links in my email campaign got clicked the most?”
“Can I get click counts per link for a sent campaign?”
Tell an agent
Show the link click breakdown for email campaign {id}.
List the referral links clicked in campaign {id} with their counts.
GET /addressbooks/{id}/campaigns List the campaigns sent to a mailing list · Get campaigns by mailing list #
Ask an LLM
“What email campaigns have been sent to a particular mailing list?”
“Can I see every campaign that targeted one address book?”
Tell an agent
List the campaigns that targeted mailing list {id}.
Show the first {limit} campaigns sent to address book {id}.
POST /campaigns/send Send a text broadcast to a chatbot's subscribers · Send campaign #
Ask an LLM
“Can I broadcast a text message to everyone subscribed to my chatbot?”
“Is it possible to schedule a chatbot campaign for later instead of sending now?”
Tell an agent
Send a text campaign titled {title} to all subscribers of bot {bot_id} with messages {messages}.
Schedule chatbot broadcast {title} for bot {bot_id} at {send_at} with messages {messages}.
POST /sms/campaigns Send an SMS campaign to a mailing list · Create a campaign for a mailing list #
Ask an LLM
“How do I send a text message campaign to the phone numbers in a mailing list?”
“Can I schedule an SMS blast to an address book for a later date?”
Tell an agent
Send SMS {body} from sender {sender} to mailing list {addressBookId}.
Schedule an SMS campaign to address book {addressBookId} from {sender} for {date} saying {body}.
DELETE /sms/campaigns Delete an SMS campaign · Delete a campaign #
Ask an LLM
“Can I delete an SMS campaign I no longer need?”
“What happens if I remove an SMS campaign record by its ID?”
Tell an agent destructive · confirm first
Delete SMS campaign {id}.
Remove the SMS campaign with ID {id} from my account.
POST /sms/send Send an SMS to a list of phone numbers · Create a campaign for a list of phone numbers #
Ask an LLM
“Can I text a handful of phone numbers directly without a mailing list?”
“How do I send an SMS to specific numbers at a scheduled time?”
Tell an agent
Text {phones} from sender {sender} with message {body}.
Send SMS {body} from {sender} to numbers {phones} on {date}.
GET /sms/campaigns/list List SMS campaigns within a date range · Get a list of campaigns by date #
Ask an LLM
“Which SMS campaigns did I send last month?”
“Can I list SMS campaigns between two dates?”
Tell an agent
List my SMS campaigns from {dateFrom} to {dateTo}.
Show all my recent SMS campaigns.
GET /sms/campaigns/info/{id} Get details of one SMS campaign · Get campaign information #
Ask an LLM
“What is the status and delivery info of one SMS campaign?”
“Can I check the results of a specific text message campaign?”
Tell an agent
Show the details of SMS campaign {id}.
Get delivery info for text campaign {id}.
PUT /sms/campaigns/cancel/{id} Cancel an SMS campaign before sending starts · Cancel a campaign before sending has started #
Ask an LLM
“Can I cancel an SMS campaign before it starts sending?”
“Is it too late to stop a scheduled text blast once sending has begun?”
Tell an agent destructive · confirm first
Cancel SMS campaign {id} before it goes out.
Stop scheduled text campaign {id}.
GET /sms/campaigns/cost Estimate the cost of an SMS campaign · Calculate the cost of a campaign #
Ask an LLM
“How much will it cost to send an SMS to my mailing list?”
“Can I estimate SMS pricing for a list of phone numbers before sending?”
Tell an agent
Calculate the cost of sending {body} from {sender} to mailing list {addressBookId}.
Estimate what it costs to text {phones} the message {body} from {sender}.
POST /viber Create a Viber campaign · Create a Viber campaign #
Ask an LLM
“How do I send a Viber message campaign to my subscribers?”
“Can I set how long a Viber message stays live before it expires?”
Tell an agent
Send a Viber campaign from sender {sender_id} to mailing list {address_book} on {send_date} with message type {message_type} and live time {message_live_time}.
Create Viber campaign {task_name} with message {message} from {sender_id}, type {message_type}, live {message_live_time}, sending {send_date}.
GET /viber/task List Viber campaigns · Get a list of campaigns #
Ask an LLM
“Which Viber campaigns have I created?”
“Can I page through my Viber message campaigns?”
Tell an agent
List my Viber campaigns.
Show {limit} Viber campaigns starting at offset {offset}.
GET /viber/task/{id} Get statistics for a Viber campaign · Get statistics on a campaign #
Ask an LLM
“How did my Viber campaign perform?”
“What are the delivery and read stats for one Viber campaign?”
Tell an agent
Show statistics for Viber campaign {id}.
Get delivery numbers for Viber task {id}.
GET /viber/task/{id}/recipients List recipients of a Viber campaign · Get a list of Viber campaign recipients #
Ask an LLM
“Who received my Viber campaign?”
“Can I get the list of phone numbers a Viber campaign went to?”
Tell an agent
List the recipients of Viber campaign {id}.
Show who Viber task {id} was sent to.
GET /push/tasks List sent web push campaigns · Get a list of sent web push campaigns #
Ask an LLM
“Which web push notifications have I sent from my website?”
“Can I list push campaigns sent between two dates for one site?”
Tell an agent
List my sent web push campaigns.
Show web push campaigns for website {website_id} from {from} to {to}.
POST /push/tasks Send a web push notification campaign · Create a new web push campaign #
Ask an LLM
“How do I send a browser push notification to my website subscribers?”
“Can I target web push notifications by browser, language or region?”
Tell an agent
Send a web push titled {title} saying {body} to website {website_id} with a lifetime of {ttl} seconds.
Schedule push notification {title} for website {website_id} on {send_date} linking to {link}, body {body}, ttl {ttl}.
GET /push/tasks/{id} Get statistics for a web push campaign · Get statistics on sent campaigns #
Ask an LLM
“How many people clicked my web push notification?”
“What are the delivery stats for one sent push campaign?”
Tell an agent
Show stats for web push campaign {id}.
Get click and delivery numbers for push task {id}.
POST /campaigns/sendTemplate Send a template message to a chatbot's subscribers · Send a campaign by template #
Ask an LLM
“Can I broadcast a message template with an image or file to all my bot subscribers?”
“Is it possible to schedule a template-based chatbot campaign?”
Tell an agent
Send template {template} as campaign {title} to all subscribers of bot {bot_id}.
Schedule template broadcast {title} for bot {bot_id} at {send_at} using template {template}.

Documentation

📖
Documentation
https://sendpulse.com/integrations/api/bulk-email
📖
APIReference
https://sendpulse.com/integrations/api
📖
Documentation
https://sendpulse.com/integrations/api/smtp
📖
Documentation
https://sendpulse.com/integrations/api/bulk-sms
📖
Documentation
https://sendpulse.com/integrations/api
📖
Documentation
https://sendpulse.com/integrations/api/chatbot
📖
Documentation
https://sendpulse.com/integrations/api/web-push

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/sendpulse/refs/heads/main/openapi/sendpulse-campaigns-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/sendpulse:sendpulse-campaigns-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

sendpulse-campaigns-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sendpulse Campaigns API
  x-refined-note:
  - x-ai-description differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Campaigns across 7 of this provider''s published API definitions: sendpulse-bulk-email-openapi.yml, sendpulse-facebook-openapi.yml, sendpulse-sms-openapi.yml, sendpulse-telegram-openapi.yml, sendpulse-viber-openapi.yml, sendpulse-web-push-openapi.yml, sendpulse-whatsapp-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.sendpulse.com
  description: Production server
- description: ''
  url: https://api.sendpulse.com/messenger
- description: ''
  url: https://api.sendpulse.com/telegram
- description: ''
  url: https://api.sendpulse.com/whatsapp
security:
- apiKey: []
- oauth2: []
tags:


# --- truncated at 32 KB (67 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sendpulse/refs/heads/main/openapi/sendpulse-campaigns-api-openapi.yml