SUsuperwall
Retention Default Messages V2

Create Retention Default Message Mapping

Changed on

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

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

Request body

application_idstring required
environment'sandbox' | 'production'

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

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
object'retention_default_message' required

Object type, always retention_default_message

application_idstring required
default_message_group_idinteger nullable required

Logical default mapping group ID, or null for legacy/standalone mappings

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

  • 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 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.