Sign in
Retention Default Messages V2

Update Retention Default Message Group

Renames a logical default mapping group and updates its desired product/locale rows. Added mappings are configured in Apple and removed mappings are deleted from Apple before the local group is updated. The sync endpoint is used to retry failed mappings.

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

Path parameters

idstring required

Retention default message group ID

Retention default message group ID

Request body

namestring

Display name of the default mapping group

product_idsstring[]

Full desired Apple product ID set for the group

localesstring[]

Full desired exact Apple locale short code set

Response

Success

idstring required

Unique identifier

object'retention_default_message_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

created_atstring required

ISO 8601 timestamp

updated_atstring required

ISO 8601 timestamp

Changes

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