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 Bulk Email API

Mailing lists, email campaigns, templates, subscribers, senders, blacklist, balance and email-service webhooks.

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

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

This API exposes 60 operations across 41 paths, organized into 9 resource areas, and defines 40 schemas. It is described by OpenAPI 3.1.2, at version 1.0.0.

Requests are made against a single base URL, https://api.sendpulse.com.

60 operations 41 paths 40 schemas 8 DELETE29 GET1 PATCH18 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.2
API Version
1.0.0
Base URL
https://api.sendpulse.com
Authentication
HTTP Bearer, OAuth 2.0
License
Apache 2.0
Resource Areas
9

Authentication & Security 2

SendPulse Bulk Email API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (API Key) (apiKey). It supports OAuth 2.0 (oauth2) 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.

Paths & Operations 60

Across 41 paths, the API surfaces 60 operations — 8 DELETE, 29 GET, 1 PATCH, 18 POST, 4 PUT. They span 9 resource areas: Mailing lists, Email address, Campaigns, Templates, Senders, Tags, Blacklist, Balance, Webhooks. Each is listed below with its method, path, parameters, and response codes.

Mailing lists 14

Endpoints related to Mailing lists.

POST
/addressbooks
Create a mailing list
createMailingList body → 200401403422
GET
/addressbooks
Get a list of mailing lists
getMailingLists 2 params → 200401403422
GET
/addressbooks/{id}
Get mailing list information
getMailingListById 1 param → 200401403404
PUT
/addressbooks/{id}
Edit a mailing list
updateMailingList 1 param body → 200401403404422
DELETE
/addressbooks/{id}
Delete a mailing list
deleteMailingList 1 param → 200401403404422
GET
/addressbooks/{id}/variables
Get a list of variables for a mailing list
getMailingListVariables 1 param → 200401403404
GET
/addressbooks/{id}/emails
Get a list of emails from a mailing list
getEmailsFromMailingList 6 params → 200401403404422
POST
/addressbooks/{id}/emails
Add emails to a mailing list
addEmailsToMailingList 1 param body → 200401403404422
DELETE
/addressbooks/{id}/emails
Delete emails from a mailing list
deleteEmailsFromMailingList 1 param body → 200401403404422
GET
/addressbooks/{id}/emails/total
Get the total number of contacts
getEmailsTotalCount 2 params → 200401403404
POST
/addressbooks/{id}/emails/unsubscribe
Unsubscribe contacts from a mailing list
unsubscribeEmailsFromMailingList 1 param body → 200401403404422
GET
/addressbooks/{id}/variables/{variableName}/{searchValue}
Get contacts by variable
getContactsByVariable 3 params → 200401403404422
PUT
/addressbooks/{id}/phone
Change a phone number for a contact
updateContactPhone 1 param body → 200401403404422
GET
/addressbooks/{id}/cost
Get campaign cost
getCampaignCostByList 1 param → 200401403404422
Email address 9

Endpoints related to Email address.

POST
/addressbooks/{id}/emails/variable
Update variables for a contact in a mailing list
updateContactVariables 1 param body → 200401403404422
GET
/emails/{email}
Get general info for an email
getEmailInfo 1 param → 200401403
DELETE
/emails/{email}
Delete email globally
deleteEmailGlobally 1 param → 200401403
GET
/emails/{email}/details
Get detailed info for an email
getEmailDetails 1 param → 200401403
POST
/emails
Get info for multiple emails
getMultipleEmailsInfo body → 200401403
GET
/emails/{email}/campaigns
Get email stats
getEmailCampaignStats 1 param → 200401403
GET
/campaigns/{id}/email/{email}
Get info for an email from a campaign
getEmailCampaignInfo 2 params → 200401403
GET
/addressbooks/{id}/emails/{email}
Get info for an email from a mailing list
getEmailFromList 2 params → 200401403
POST
/emails/campaigns
Get stats for multiple emails
getMultipleEmailsCampaignStats body → 200401403
Campaigns 8

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
Templates 5

Endpoints related to Templates.

POST
/template
Create a template
createTemplate body → 200401403422
POST
/template/edit/{id}
Edit a template
updateTemplate 1 param body → 200401403404422
GET
/template/{template_id}
Get information about a template
getTemplateById 3 params → 200401403404422
GET
/template/slug/{name_slug}
Get a template by name slug
getTemplateBySlug 3 params → 200401403404422
GET
/templates
Get a list of templates
getTemplates 4 params → 200401403
Senders 5

Endpoints related to Senders.

GET
/senders
Get a list of all senders
getSenders → 200401403
POST
/senders
Add a sender
addSender body → 200401403
DELETE
/senders
Delete a sender
deleteSender body → 200401403
GET
/senders/{email}/code
Request activation code
requestSenderActivationCode 1 param → 200401403
POST
/senders/{email}/code
Activate a sender
activateSender 1 param body → 200401403
Tags 8

Endpoints related to Tags.

GET
/tags
Get a list of tags
getTags → 200401403
POST
/tags
Create a tag
createTag body → 200401403
PUT
/tags/{id}
Update a tag
updateTag 1 param body → 200401403
DELETE
/tags/{id}
Delete a tag
deleteTag 1 param → 200401403
POST
/tags/pin/email
Assign tag to email
pinTagToEmail body → 200401403
POST
/tags/pin/phone
Assign tag to phone
pinTagToPhone body → 200401403
POST
/tags/unpin/email
Unassign tag from email
unpinTagFromEmail body → 200401403
POST
/tags/unpin/phone
Unassign tag from phone
unpinTagFromPhone body → 200401403
Blacklist 3

Endpoints related to Blacklist.

GET
/blacklist
Get blacklist
getBlacklist → 200401403
POST
/blacklist
Add to blacklist
addToBlacklist body → 200401403
DELETE
/blacklist
Remove from blacklist
removeFromBlacklist body → 200401403
Balance 3

Endpoints related to Balance.

GET
/balance
Get balance
getBalance → 200401403
GET
/balance/{currency}
Get balance by currency
getBalanceByCurrency 1 param → 200401403
GET
/user/balance/detail
Get detailed balance
getDetailedBalance → 200401403
Webhooks 5

Endpoints related to Webhooks.

GET
/v2/email-service/webhook
Get webhooks
getWebhooks → 200401403
POST
/v2/email-service/webhook
Create a webhook
createWebhook body → 200401403
GET
/v2/email-service/webhook/{id}
Get webhook by ID
getWebhookById 1 param → 200401403
PUT
/v2/email-service/webhook/{id}
Update a webhook
updateWebhook 1 param body → 200401403
DELETE
/v2/email-service/webhook/{id}
Delete a webhook
deleteWebhook 1 param → 200401403

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are CampaignCreateRequest (16 properties), TagQueueResponse (8 properties), MailingList (8 properties), CampaignCreateResponse (6 properties). Each schema is shown below with its type and property counts.

MailingList
object
8 properties
VariableDefinition
object
2 properties
EmailContact
object
4 properties
EmailContactBasic
object
3 properties
ResultTrue
object
1 property
ResultTrueWithId
object
2 properties
CampaignCost
object
4 properties
CampaignCreateRequest
object
16 properties 3 required
CampaignCreateResponse
object
6 properties
CampaignSummary
object
3 properties
CampaignDetails
object
3 properties
CampaignUpdateRequest
object
2 properties
ReferralStat
object
2 properties
CampaignByListSummary
object
1 property
TemplateDetails
object
2 properties
TemplateSummary
object
2 properties
Sender
object
2 properties
SenderActivationResponse
object
1 property
EmailAcrossBooks
object
2 properties
EmailDetails
object
2 properties
EmailInfoShort
object
1 property
SubscriberStats
object
1 property
AddEmailsSingleOptIn
object
1 property
AddEmailsDoubleOptIn
object
2 properties
Tag
object
3 properties
TagListResponse
object
3 properties
TagCreateRequest
object
2 properties 2 required
TagUpdateRequest
object
2 properties 2 required
TagQueueResponse
object
8 properties
TagPinUnpinEmailRequest
object
2 properties 2 required
TagPinUnpinPhoneRequest
object
2 properties 2 required
BlacklistAddRequest
object
2 properties 1 required
BlacklistDeleteRequest
object
1 property 1 required
BalanceResponse
object
2 properties
DetailedBalanceResponse
object
4 properties
Webhook
object
4 properties
WebhookListResponse
object
2 properties
WebhookResponse
object
2 properties
WebhookCreateRequest
object
2 properties 2 required
WebhookUpdateRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sendpulse-bulk-email-openapi.yml Raw ↑

Other APIs SendPulse publishes across the network.

SendPulse SMTP API
SendPulse SMS API
SendPulse CRM Public API
SendPulse Automation 360 API
SendPulse Chatbots Service API
SendPulse WhatsApp Chatbot API
SendPulse Telegram Chatbot API
SendPulse Facebook Messenger Chatbot API
SendPulse Instagram Chatbot API
SendPulse Viber Chatbot API
SendPulse TikTok Chatbot API
SendPulse LiveChat API
Where this information came from

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