SUsuperwall
Retention Messages V2

Create Retention Message

Changed on

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

post/v2/retention-messages

Request

  • Base URL
    https://api.superwall.com
  • URL
    https://api.superwall.com/v2/retention-messages
  • Auth
    • HTTP bearer
    • or API key in cookie accounts_superwall_token
    • or HTTP bearer

Request body

application_idstring required
namestring required

Display name of the retention message

environment'sandbox' | 'production'

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

localestring required

BCP-47 locale code

headerstring required

Message header text

bodystring required

Message body text

alt_textstring

Image alt text

image_identifierstring

Apple image identifier (must be pre-uploaded)

Response

Success

idstring required
object'retention_message' required

Object type, always retention_message

application_idstring required
message_group_idinteger nullable required

Logical message group ID, or null for legacy/standalone messages

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

  • 778a11cd2c15Revision changes
    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • info

      added subschema #1 subschema #2 to the response body anyOf list for the response status

    • info

      added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 to the response body anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response body anyOf list for the response status

    • info

      removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 from the response body anyOf list for the response status

  • 217c96dc9a29Revision changes
    • breaking

      removed the enum value production of the request property

    • breaking

      removed the enum value sandbox of the request property

    • breaking

      the request property type changed from string to no type

    • breaking

      the request property type changed from string to no type

    • breaking

      the request property type changed from string to no type

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from number to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from number to no type for status

    This list may be incomplete.