Sign in
Retention Configurations V2

Update Retention Configuration Group

Updates realtime configuration group metadata and, when product_ids or locales are provided, atomically replaces the group's product/locale configuration rows.

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

Path parameters

idstring required

Retention configuration group ID

Retention configuration group ID

Request body

namestring

Display name of the configuration group

message_group_idinteger

Message group to resolve per-locale variants from

product_idsstring[]

Full replacement set of Apple product IDs

localesstring[]

Full replacement set of exact runtime locale codes

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

Type of retention offer

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_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.