# Superwall Retention Messaging Onboarding V2 API

**Canonical:** https://apis.io/apis/superwall/superwall-retention-messaging-onboarding-v2-api/  
**Provider:** Superwall — https://apis.io/providers/superwall/  
**Base URL:** https://api.superwall.com  
**Documentation:** https://api.superwall.com/docs

Superwall Retention Messaging Onboarding V2 API is one of 42 APIs that [Superwall](https://apis.io/providers/superwall/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Retention Messaging Onboarding V2. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Dashboard onboarding actions for Apple retention messaging setup.

## Operations (8)

| Method | Path | Summary |
|---|---|---|
| GET | `/v2/retention-onboarding/status` | Get Retention Messaging Onboarding Status |
| POST | `/v2/retention-onboarding/apple-access/check` | Check Apple Retention Messaging Access |
| POST | `/v2/retention-onboarding/sandbox/realtime-url` | Configure Sandbox Retention Realtime URL |
| POST | `/v2/retention-onboarding/sandbox/active-subscription` | Find Active Sandbox App Store Subscription |
| POST | `/v2/retention-onboarding/sandbox/performance-test` | Start Sandbox Retention Performance Test |
| POST | `/v2/retention-onboarding/sandbox/performance-test/result` | Check Sandbox Retention Performance Test |
| POST | `/v2/retention-onboarding/production/realtime-url` | Configure Production Retention Realtime URL |
| POST | `/v2/retention-onboarding/production/realtime-url/check` | Check Production Retention Realtime URL |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/superwall/openapi/superwall-retention-messaging-onboarding-v2-api-openapi.yml
- **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

## Other Superwall APIs (12)

- [Superwall App Store Connect Configurations V2 API](https://apis.io/apis/superwall/superwall-app-store-connect-configurations-v2-api/)
- [Superwall App User Erasures V2 API](https://apis.io/apis/superwall/superwall-app-user-erasures-v2-api/)
- [Superwall Application Webapp Origins V2 API](https://apis.io/apis/superwall/superwall-application-webapp-origins-v2-api/)
- [Superwall Assets V2 API](https://apis.io/apis/superwall/superwall-assets-v2-api/)
- [Superwall Audit Logs V2 API](https://apis.io/apis/superwall/superwall-audit-logs-v2-api/)
- [Superwall Campaigns V2 API](https://apis.io/apis/superwall/superwall-campaigns-v2-api/)
- [Superwall Chart Annotations API](https://apis.io/apis/superwall/superwall-chart-annotations-api/)
- [Superwall Charts V2 API](https://apis.io/apis/superwall/superwall-charts-v2-api/)
- [Superwall CLI Agent V2 API](https://apis.io/apis/superwall/superwall-cli-agent-v2-api/)
- [Superwall Custom Store Events API](https://apis.io/apis/superwall/superwall-custom-store-events-api/)
- [Superwall Custom Stores API](https://apis.io/apis/superwall/superwall-custom-stores-api/)
- [Superwall Demand Score V2 API](https://apis.io/apis/superwall/superwall-demand-score-v2-api/)

## Tags

Retention Messaging Onboarding V2

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/superwall/superwall-retention-messaging-onboarding-v2-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/superwall/.