Sign in
Retention Messages V2

Create Retention Message

Creates a new retention message, generates Apple message identifiers, and uploads to Apple. Requires retention_messages:write scope.

post/v2/retention-messages

Request body

application_idstring required

Application ID to create the message for

namestring required

Display name of the retention message

environment'sandbox' | 'production'

Apple environment for message upload

localestring required

BCP-47 locale code

headerstring required

Message header text

bodystring required

Message body text

alt_textstring

a string at most 512 character(s) long

image_identifierstring

Response

Success

idstring required

Unique identifier

object'retention_message' required

Object type, always retention_message

application_idstring required

Application ID

message_group_idinteger nullable required

an integer

namestring required

Display name of the retention message

environment'sandbox' | 'production' required

Apple environment this message belongs to

localestring required

BCP-47 locale code (e.g. en-US)

apple_message_identifierstring required

Current Apple message identifier

apple_message_state'PENDING' | 'APPROVED' | 'REJECTED' | 'UNKNOWN' required

Raw Apple review state for this message identifier

apple_upload_state'not_uploaded' | 'uploading' | 'uploaded' | 'failed' required

Superwall-to-Apple upload state

apple_upload_attempt_countnumber required
apple_upload_last_errorstring nullable required
apple_uploaded_atstring nullable required
headerstring required

Message header text

bodystring required

Message body text

alt_textstring nullable required

Image alt text, or null

image_identifierstring nullable required

Apple image identifier (pre-uploaded), or null

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.