Sign in
Retention Configurations V2

Update Retention Configuration

Updates a retention configuration in Superwall. Apple and App Store Connect may be queried for validation, but no Apple-side configuration is written. Requires retention_messages:write scope.

patch/v2/retention-configurations/{id}

Path parameters

idstring required

Retention configuration ID

Retention configuration ID

Request body

namestring

Display name

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

Type of retention offer

retention_message_idinteger

ID of the retention message to use

alternate_product_idstring nullable

Alternate product ID

offer_identifierstring nullable

Promotional offer identifier

offer_product_idstring nullable

Product ID the offer applies to

Response

Success

idstring required

Unique identifier

object'retention_configuration' required

Object type, always retention_configuration

application_idstring required

Application ID

configuration_group_idinteger nullable required

an integer

namestring required

Display name of the configuration

environment'sandbox' | 'production' required

Environment this configuration applies to

product_idstring required

Apple product ID

localestring required

Locale code for this configuration

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

Type of retention offer: message, alternate_product, or promotional_offer

retention_message_idinteger required

ID of the linked retention message

alternate_product_idstring nullable required

Alternate product ID (for alternate_product type)

offer_identifierstring nullable required

Promotional offer identifier (for promotional_offer type)

offer_product_idstring nullable required

Product ID the offer applies to (for promotional_offer type)

created_atstring required

ISO 8601 timestamp

updated_atstring required

ISO 8601 timestamp

Changes

No recorded changes to this endpoint across all 1 revision of this API.