Superwall

Superwall Retention Messages V2 API

Manage retention messages for Apple subscription win-back. Messages are stored locally and uploaded to Apple for review.

Documentation GitHub OpenAPI

Operations 11

GET /v2/retention-messages List Retention Messages #

POST /v2/retention-messages Create Retention Message #

GET /v2/retention-messages/groups List Retention Message Groups #

POST /v2/retention-messages/groups Create Retention Message Group #

POST /v2/retention-messages/{id}/group Create Retention Message Group From Message #

POST /v2/retention-messages/groups/from-messages Create Retention Message Group From Messages #

POST /v2/retention-messages/groups/{id}/upload Upload Retention Message Group #

PATCH /v2/retention-messages/groups/{id} Update Retention Message Group #

DELETE /v2/retention-messages/groups/{id} Delete Retention Message Group #

GET /v2/retention-messages/{id} Retrieve Retention Message #

DELETE /v2/retention-messages/{id} Delete Retention Message #

Specifications

https://artifacts.apis.io/superwall/openapi/superwall-retention-messages-v2-api-openapi.yml

Schemas & Data

https://artifacts.apis.io/superwall/json-schema/superwall-audit-log-entry-with-actor-schema.json

https://artifacts.apis.io/superwall/json-schema/superwall-custom-store-event-schema.json

https://artifacts.apis.io/superwall/json-schema/superwall-rule-conditions-schema.json

https://artifacts.apis.io/superwall/json-schema/superwall-rule-conditions-1-schema.json

https://artifacts.apis.io/superwall/json-schema/superwall-doctor-report-schema.json

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-retention-messages-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

openapi: 3.2.0
info:
  title: Superwall API V2 Retention Messages 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 (324 KB total) ---
# Full source: https://artifacts.apis.io/superwall/openapi/superwall-retention-messages-v2-api-openapi.yml