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 Pop-up API

Website pop-up creation and management, project organisation, and delivery and conversion statistics.

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

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

This API exposes 15 operations across 15 paths, organized into 6 resource areas, and defines 12 schemas. It is described by OpenAPI 3.1.2, at version 1.0.

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

15 operations 15 paths 12 schemas 1 DELETE12 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.2
API Version
1.0
Base URL
https://api.sendpulse.com/v2/pop-ups
Authentication
HTTP Bearer, OAuth 2.0, OAuth 2.0
Resource Areas
6

Authentication & Security 3

SendPulse Pop-up API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (API Key) (apiKey). It supports OAuth 2.0 (outh2) using the clientCredentials flow. 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.
  • outh2 — OAuth 2.0 Client Credentials flow for temporary access tokens.
  • oauth2 — OAuth 2.0 Client Credentials flow for temporary access tokens.

Paths & Operations 15

Across 15 paths, the API surfaces 15 operations — 1 DELETE, 12 GET, 2 POST. They span 6 resource areas: Project, Popup, Project statistic, Popup statistic, Tariff, Subscribers. Each is listed below with its method, path, parameters, and response codes.

Project 2
GET
/public/api/widgets/list
Get a list of projects
listWidgets 2 params → 200400401404
POST
/public/api/widgets
Create a project
createWidget body → 201400401404
Popup 5
GET
/public/api/popups/conditions
Get a list of available display conditions for popups
getPopupConditions → 200
GET
/public/api/popups/list/quiz/{projectId}
Get a list of quiz pop-ups by your project ID
listQuizPopupsByProject 3 params → 200400401403404
GET
/public/api/popups/list/{projectId}
Get a list of pop-ups by your project ID
listPopupsByProjectId 3 params → 200400401403404
POST
/public/api/popups/{popupId}/set-state
Set a pop-up state
setPopupState 1 param body → 200400401404
DELETE
/public/api/popups/{popupId}
Delete popup
deletePopup 1 param body → 200400401403404
Project statistic 1
GET
/public/api/statistics/widget/{projectId}
Get statistics about your project
getProjectWidgetStatistics 3 params → 200400401404
Popup statistic 3
GET
/public/api/statistics/popup/{popupId}
Get statistics about your pop-up
getPopupStatistics 3 params → 200400401404
GET
/public/api/statistics/nps/{popupId}
Get NPS variants statistics and base NPS button/buttons info
getNpsStatisticsByPopupId 3 params → 200400401404
GET
/public/api/statistics/nps/{popupId}/aggregated
Get NPS statistics
getPopupAggregatedNpsStatistics 3 params → 200400401404
Tariff 1
GET
/public/api/tariff/limits
Get info about user tariff plan
getTariffLimits → 200401
Subscribers 3
GET
/public/api/subscribers/get/{subscriberId}
Get subscriber
getSubscriberById 1 param → 200400401403404
GET
/public/api/subscribers/by-popup/{popupId}
Get subscriber by popup
getSubscribersByPopup 1 param → 200400401403404
GET
/public/api/subscribers/by-project/{projectId}
Get subscriber by project
listSubscribersByProject 1 param → 200400401403404

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are popup (17 properties), subscriber (11 properties), aggregatedNPSStatistic (8 properties), project (7 properties). Each schema is shown below with its type and property counts.

project
object
7 properties
popup
object
17 properties
popupStatistic
object
5 properties
NPSStatistic
object
4 properties
aggregatedNPSStatistic
object
8 properties
projectStatistic
object
6 properties
pageInfo
object
4 properties
scenarioSetting
object
4 properties
userPlanInfo
object
6 properties
subscriber
object
11 properties
unauthorizedResponse
Unauthorized
accessDeniedResponse
Access denied

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sendpulse-popups-openapi.yml Raw ↑

Other APIs SendPulse publishes across the network.

SendPulse Bulk Email API
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
Where this information came from

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