Sign in
Retention Configurations V2

Create Retention Configurations For Products

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

post/v2/retention-configurations/for-products

Request body

application_idstring required

Application ID to create configurations for

namestring required

Display name of the configurations

environment'sandbox' | 'production'

Environment for these configurations (defaults to production if omitted)

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

No recorded changes to this endpoint across all 4 revisions of this API.