About Poptin APIs

The Poptin API lets you programmatically manage the same objects you work with in the Poptin app - poptins (popups and forms), contacts, conversions, email campaigns, and background jobs - from your own backends, integrations, and internal tools.

All operations documented here are served from a single base URL:

https://api.popt.in/v1

Requests are authenticated with an API key issued from the Poptin app under My Account → API & Connections → API Keys. Keys start with pk_live_ and are sent as a bearer token on every request. See Authentication for the full details.

Who this API is for

Agencies and product teams embedding Poptin into a broader marketing or growth stack.
Developers and IT syncing Poptin data with CRMs, data warehouses, or internal systems.
Operators automating repetitive workflows - imports, segmentation, campaign sends, and reporting.

If you interact with Poptin data outside the dashboard, this is your entry point.

What you can build

The Public API covers the operational surface of Poptin:

Inspect and manage poptins - list popups and forms, retrieve their configuration, and retrieve analytics.
Read conversions - access leads and actions captured by your poptins for analytics, routing, or downstream sync.
Manage contacts - create, retrieve, update, import, and delete contacts.
Model your data - define custom properties (contact fields) and subscription preferences that match your business.
Run email campaigns - list campaigns, review analytics, control status, and send template emails to subscribed contacts.
Track async work - monitor bulk jobs for long-running operations like imports, deletions, and mass sends.

How this portal works

The portal is split into two sections with distinct jobs:

Guides

Concepts, policies, and getting-started material. Read these first to understand how Poptin models data and how to authenticate.

API Reference

Every operation, its parameters, request and response contracts, and a Try It explorer to run live calls against your account.

Recommended path:

Quickstart - make your first authenticated request.
Authentication - how API keys and bearer tokens work.
API Reference - browse operations and try them live.

Scope

This portal documents the Public API only. The following are intentionally out of scope:

Embed and on-page display internals used by the Poptin JavaScript on your site.
Marketplace and partner authentication flows.

If you need something in those areas, contact Poptin support - they are not covered by these docs.

Naming cheat sheet

Poptin uses a few product-specific terms. The API keeps them consistent with the app:

In the API	What it means
contacts	People on your contact list
properties	Custom contact fields and attributes
poptins	Popups and forms
conversions	Leads and actions captured from popups and forms
campaigns	Email campaigns sent to your contacts
bulk jobs	Background tasks for long-running operations

Next steps

Quickstart

Make your first authenticated call to the Poptin API.

Sandbox Testing

Try operations live with the Reference explorer and cURL.

Authentication

Create API keys and send bearer tokens correctly.

API Reference

Browse every operation, parameter, and response.