Superwall

Superwall Campaigns V2 API

Manage campaigns, placements, and audiences. A Campaign controls when and to whom paywalls are displayed. Campaigns are scoped to a specific application (per-platform) since triggers and audience rules are platform-specific.

GitHub OpenAPI

Operations 34

GET /v2/campaigns List Campaigns #
POST /v2/campaigns Create Campaign #
GET /v2/campaigns/overview-stats Campaign Overview Stats #
GET /v2/campaigns/event-properties Event Properties #
GET /v2/campaigns/web-paywall-domains List Web Paywall Domains #
GET /v2/campaigns/{id} Retrieve Campaign #
PATCH /v2/campaigns/{id} Update Campaign #
GET /v2/campaigns/{id}/assignment-counts Campaign Audience Assignment Counts #
POST /v2/campaigns/{id}/archive Archive Campaign #
POST /v2/campaigns/{id}/unarchive Unarchive Campaign #
POST /v2/campaigns/{id}/prioritize Prioritize Campaign #
POST /v2/campaigns/{id}/placements Add Placement #
PATCH /v2/campaigns/{id}/placements/{placement_id} Update Placement #
DELETE /v2/campaigns/{id}/placements/{placement_id} Remove Placement #
PATCH /v2/campaigns/{id}/audiences/{audience_id} Update Audience #
DELETE /v2/campaigns/{id}/audiences/{audience_id} Remove Audience #
POST /v2/campaigns/{id}/audiences Create Audience #
POST /v2/campaigns/{id}/audiences/{audience_id}/duplicate Duplicate Audience #
POST /v2/campaigns/{id}/audiences/import Import Audience #
PUT /v2/campaigns/{id}/audiences/order Reorder Audiences #
POST /v2/campaigns/{id}/audiences/{audience_id}/reset Reset Audience Assignments #
POST /v2/campaigns/{id}/audiences/{audience_id}/variants Create Variant #
PATCH /v2/campaigns/{id}/audiences/{audience_id}/variants/{variant_id} Update Variant #
DELETE /v2/campaigns/{id}/audiences/{audience_id}/variants/{variant_id} Remove Variant #
GET /v2/campaigns/{id}/audiences/{audience_id}/users Audience Users #
GET /v2/campaigns/{id}/audiences/{audience_id}/recent-matches Audience Recent Matches #
POST /v2/campaigns/{id}/audiences/{audience_id}/generate-rule Generate Audience Rule #
GET /v2/campaigns/{id}/audiences/{audience_id}/purchasers Audience Purchasers #
GET /v2/campaigns/{id}/audiences/{audience_id}/readout Audience Readout #
GET /v2/campaigns/{id}/audiences/{audience_id}/chart Audience Results Chart #
GET /v2/campaigns/{id}/audiences/{audience_id}/attribution Audience Attribution Breakdown #
GET /v2/campaigns/{id}/audiences/{audience_id}/attribution/meta/ads/{ad_id}/creative Preview an Attributed Meta Ad #
GET /v2/campaigns/{id}/audiences/{audience_id}/dropoff Audience Flows #
PUT /v2/campaigns/{id}/audiences/{audience_id}/weights Update Audience Weights #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/superwall/openapi/superwall-campaigns-v2-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/superwall/json-schema/superwall-audit-log-entry-with-actor-schema.json
📊
JSONSchema
https://artifacts.apis.io/superwall/json-schema/superwall-custom-store-event-schema.json
📊
JSONSchema
https://artifacts.apis.io/superwall/json-schema/superwall-rule-conditions-schema.json
📊
JSONSchema
https://artifacts.apis.io/superwall/json-schema/superwall-rule-conditions-1-schema.json
📊
JSONSchema
https://artifacts.apis.io/superwall/json-schema/superwall-doctor-report-schema.json
📊
JSONSchema
https://artifacts.apis.io/superwall/json-schema/superwall-audit-log-list-schema.json

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/superwall:superwall-campaigns-v2-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

superwall-campaigns-v2-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Superwall API V2 Campaigns V2 API
  version: 2.0.0
  description: Superwall V2 API - Scope-based authentication with organization API keys
servers:
- url: https://api.superwall.com
  description: Production
- url: https://api.superwall.dev
  description: Staging
- url: /
  description: Local
security: []
tags:


# --- truncated at 32 KB (1054 KB total) ---
# Full source: https://artifacts.apis.io/superwall/openapi/superwall-campaigns-v2-api-openapi.yml