App Store Connect Configurations V25

App User Erasures V24

Application Webapp Origins V23

Assets V26

Audit Logs V22

Campaigns V234

Chart Annotations5

Charts V28

CLI Agent V22

Custom Store Events1

Custom Stores8

Demand Score V23

Entitlements V28

Events V24

Google Play V28

Grants V21

Imports1

Integration Event Names (Service)1

Me V25

Notifications1

Onboarding V21

Organization Access V211

Organizations V22

Paywall Resolver (Public)2

Paywall Templates (Public)1

Paywalls V217

Products V211

Project Auth V26

Project Transfers V27

Projects V224

Query V22

Retention Configurations V212

Retention Default Messages V29

Retention Messages V211

Retention Messaging Onboarding V28

retentionCampaignsV29

RevenueCat V1 (compatible)1

RevenueCat V2 (compatible)4

Stripe Customer Links V21

Surveys V212

Users V214

Users V34

Web2App Integrations V25

Webhooks V212

WorkOS Organization Admin1

Retention Configurations V2

Create Retention Configurations For Products

Changed on Oct 29, 2026

Creates retention configurations for multiple products as one backend workflow. Requires retention_messages:write scope.

post/v2/retention-configurations/for-products

Request

Base URL
https://api.superwall.com
URL
https://api.superwall.com/v2/retention-configurations/for-products
Auth
- HTTP bearer
- or API key in cookie accounts_superwall_token
- or HTTP bearer

Request body

application_idstring required

namestring required

Display name of the configurations

environment'sandbox' | 'production'

Apple environment: 'sandbox' for testing, 'production' for live

product_idsstring[] required

Apple product IDs

localestring required

Locale code for these configurations

type'message' | 'alternate_product' | 'promotional_offer' required

Type of retention offer: message, alternate_product, or promotional_offer

retention_message_idinteger required

ID of the retention message to use

alternate_product_idstring

Alternate product ID (required for alternate_product type)

offer_identifierstring

Promotional offer identifier (required for promotional_offer type)

offer_product_idstring

Product ID the offer applies to (required for promotional_offer type)

Response

Success

object'list' required

Changes

Oct 29, 2026778a11cd2c15 Revision changes
- warning
  added the new credentials_missing enum value to the / response property for the response status
- warning
  added the new credentials_missing enum value to the / response property for the response status
- warning
  added the new credentials_missing enum value to the / response property for the response status
- warning
  added the new credentials_missing enum value to the / response property for the response status
- warning
  added the new credentials_missing enum value to the / response property for the response status
- info
  added subschema #1 subschema #2 to the response body anyOf list for the response status
- info
  added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 to the response body anyOf list for the response status
- info
  removed subschema #1 subschema #2 from the response body anyOf list for the response status
- info
  removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 from the response body anyOf list for the response status
Sep 9, 2026217c96dc9a29 Revision changes
- breaking
  removed the enum value production of the request property
- breaking
  removed the enum value sandbox of the request property
- breaking
  the request property type changed from string to no type
- breaking
  the request property type changed from string to no type
- breaking
  the request property type changed from string to no type
- breaking
  the request property type changed from string to no type
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from number to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from number to no type for status
This list may be incomplete.

Operation history

Create Retention Configurations For Products

Request

Request body

Response 200OK

Changes

Response