Sign in
Retention Default Messages V2

Create Retention Default Message Mapping

Creates or replaces a default message mapping. Apple configure call succeeds first, then DB is upserted. Requires retention_messages:write scope.

post/v2/retention-default-messages

Request body

application_idstring required

Application ID to create the default mapping for

environment'sandbox' | 'production'

Environment for this default mapping

product_idstring required

Apple product ID

localestring required

Locale code

retention_message_idinteger required

Retention message ID used for this default mapping

Response

Success

idstring required

Unique identifier

object'retention_default_message' required

Object type, always retention_default_message

application_idstring required

Application ID

default_message_group_idinteger nullable required

an integer

environment'sandbox' | 'production' required

Environment this default message mapping applies to

product_idstring required

Apple product ID

localestring required

Locale code for this mapping

retention_message_idinteger required

Linked retention message ID

message_namestring required

Linked retention message name

apple_message_identifierstring required

Apple message identifier configured for this default mapping

apple_sync_state'not_synced' | 'syncing' | 'synced' | 'failed' required

Apple default-message sync state

apple_sync_attempt_countnumber required
apple_sync_last_errorstring nullable required
apple_synced_atstring 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.