Sign in
Retention Configurations V2

Create Retention Configuration Group

Creates realtime configurations for multiple products and locales as one backend workflow.

post/v2/retention-configurations/groups

Request body

application_idstring required

Application ID to create configurations for

namestring required

Display name of the configuration group

environment'sandbox' | 'production'

Environment for these configurations (defaults to production if omitted)

message_group_idinteger required

Message group to resolve per-locale variants from

product_idsstring[] required

Apple product IDs

localesstring[] required

Exact runtime locale codes

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

Type of retention offer: message, alternate_product, or promotional_offer

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

idstring required

Unique identifier

object'retention_configuration_group' required
application_idstring required

Application ID

namestring required

Display name

environment'sandbox' | 'production' required

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

message_group_idinteger required

an integer

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

Type of retention offer: message, alternate_product, or promotional_offer

alternate_product_idstring nullable required
offer_identifierstring nullable required
offer_product_idstring nullable required
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.