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 Messages V2

Update Retention Message Group

Changed on Oct 29, 2026

Updates logical message group metadata and, when message_ids is provided, atomically replaces group membership using existing messages. This does not upload anything to Apple.

patch/v2/retention-messages/groups/{id}

Request

Base URL
https://api.superwall.com
URL
https://api.superwall.com/v2/retention-messages/groups/{id}
Auth
- HTTP bearer
- or API key in cookie accounts_superwall_token
- or HTTP bearer

Path parameters

idstring required

Request body

namestring

Display name of the message group

default_retention_message_idinteger

Selected message to use as the group's fallback/default message

message_idsinteger[]

Full replacement set of existing messages in this group. Messages must be ungrouped or already in this group.

Response

Success

idstring required

object'retention_message_group' required

application_idstring required

namestring required

Display name

environment'sandbox' | 'production' required

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

default_retention_message_idinteger nullable required

created_atstring required

ISO 8601 timestamp

updated_atstring required

ISO 8601 timestamp

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 subschema #3 subschema #4 subschema #5 to 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
  the request property type changed from integer to no type
- breaking
  the request property type changed from array to no type
- breaking
  the request property type changed from string to no type
- breaking
  the request property type changed from array 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 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
This list may be incomplete.

Operation history