SUsuperwall
retentionCampaignsV2

POST /v2/retention-campaigns/configurations

Changed on

Request

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

Request body

application_idstring required
environment'sandbox' | 'production' required

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

namestring required
message_group_idinteger required

Message group to resolve per-locale variants from

type'message' | 'alternate_product' | 'promotional_offer' required

Type of retention offer: message, alternate_product, or promotional_offer

alternate_product_idstring

Alternate product ID (required for alternate_product type)

offer_identifierstring

Promotional offer identifier (required for promotional_offer type)

offer_product_idstring

Product ID the offer applies to (required for promotional_offer type)

Response

Success

idstring required
object'retention_configuration_group' required
application_idstring required
namestring required

Display name

environment'sandbox' | 'production' required

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

message_group_idinteger required
type'message' | 'alternate_product' | 'promotional_offer' required

Type of retention offer: message, alternate_product, or promotional_offer

alternate_product_idstring nullable required
offer_identifierstring nullable required
offer_product_idstring 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

  • a41d471f35ebRevision changes
    • info

      endpoint added