Sign in
Retention Messages V2

Update Retention Message Group

Updates logical message group metadata and, when message_ids is provided, atomically replaces group membership using existing messages. This does not upload anything to Apple.

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

Path parameters

idstring required

Retention message group ID

Retention message group ID

Request body

namestring

Display name of the message group

default_retention_message_idinteger

Selected message to use as the group's fallback/default message

message_idsinteger[]

Full replacement set of existing messages in this group. Messages must be ungrouped or already in this group.

Response

Success

idstring required

Unique identifier

object'retention_message_group' required
application_idstring required

Application ID

namestring required

Display name

environment'sandbox' | 'production' required

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

default_retention_message_idinteger nullable required

an integer

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.