Paywalls V2

Promote Headless Version

Changed on

Points production at a pushed headless version (the latest by default): repoints the deployed version and stamps the paywall URL delivered to SDKs. Requires paywalls:write scope.

post/v2/paywalls/{id}/promote

Request

  • Base URL
    https://api.superwall.com
  • URL
    https://api.superwall.com/v2/paywalls/{id}/promote
  • Auth
    • HTTP bearer
    • or API key in cookie accounts_superwall_token
    • or HTTP bearer

Path parameters

idstring required

Request body

versionnumber

The pushed version number to promote. Defaults to the latest pushed version.

Response

Success

object'paywall' required

Object type, always paywall

idstring required
versionnumber required

The version now live in production

urlstring required

Immutable URL of the now-live snapshot

promoted_atstring required

ISO 8601 timestamp of when the version was promoted

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

    • warning

      added the new credentials_missing enum value to the / response property 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 subschema #3 subschema #4 subschema #5 from the response body anyOf list for the response status

    • breaking

      the request property type changed from number 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 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

    • info

      added subschema #1 to the request property anyOf list

    • info

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

    • info

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

    • info

      removed subschema #1: Missing API Key subschema #2: Invalid API Key Format subschema #3: Invalid API Key subschema #4: Authentication Failed subschema #5: Invalid Session from the response body anyOf list for the response status

    • info

      removed subschema #2: Bad Request from the response body anyOf list for the response status

    • info

      added subschema #1 to the response property anyOf list for the response status

    • info

      added subschema #1 to the response property anyOf list for the response status

    • info

      added subschema #1 to the response property anyOf list for the response status

    • info

      added subschema #1 to the response property anyOf list for the response status

    • info

      added subschema #1 to the response property anyOf list for the response status

    • info

      added subschema #1 to the response property anyOf list for the response status

    • info

      added subschema #1 to the response property anyOf list for the response status

    • info

      added subschema #1 to the response property anyOf list for the response status

    • info

      added subschema #1 to the response property anyOf list for the response status

    • info

      added subschema #1 to the response property anyOf list for the response status

    • info

      added subschema #1 to the response property anyOf list for the response status

    • info

      added subschema #1 to the response property anyOf list for the response status

    • info

      added subschema #1 to the response property anyOf list for the response status

    • info

      added subschema #1 to the response property anyOf list for the response status

    • info

      added subschema #1 to the response property anyOf list for the response status

    • info

      added subschema #1 to the response property anyOf list for the response status

    • info

      added subschema #1 to the response property anyOf list for the response status

    • info

      added subschema #1 to the response property anyOf list for the response status

    • info

      added subschema #1 to the response property anyOf list for the response status

    • info

      added subschema #1 to the response property anyOf list for the response status

    • info

      added subschema #1 to the response property anyOf list for the response status

    • info

      removed the api_error enum value from the response property for the response status

    • info

      removed the api_error enum value from the response property for the response status

    • info

      removed the api_error enum value from the response property for the response status

    • info

      removed the api_error enum value from the response property for the response status

    • info

      removed the api_error enum value from the response property for the response status

    • info

      removed the authentication_error enum value from the response property for the response status

    • info

      removed the authentication_error enum value from the response property for the response status

    • info

      removed the authentication_error enum value from the response property for the response status

    • info

      removed the authentication_error enum value from the response property for the response status

    • info

      removed the authentication_error enum value from the response property for the response status

    • info

      removed the authentication_failed enum value from the response property for the response status

    • info

      removed the authentication_failed enum value from the response property for the response status

    • info

      removed the authentication_failed enum value from the response property for the response status

    • info

      removed the authentication_failed enum value from the response property for the response status

    • info

      removed the authentication_failed enum value from the response property for the response status

    • info

      removed the idempotency_key_in_use enum value from the response property for the response status

    • info

      removed the idempotency_key_in_use enum value from the response property for the response status

    • info

      removed the idempotency_key_in_use enum value from the response property for the response status

    • info

      removed the idempotency_key_in_use enum value from the response property for the response status

    • info

      removed the idempotency_key_in_use enum value from the response property for the response status

    • info

      removed the insufficient_permissions enum value from the response property for the response status

    • info

      removed the insufficient_permissions enum value from the response property for the response status

    • info

      removed the insufficient_permissions enum value from the response property for the response status

    • info

      removed the insufficient_permissions enum value from the response property for the response status

    • info

      removed the insufficient_permissions enum value from the response property for the response status

    • info

      removed the internal_error enum value from the response property for the response status

    • info

      removed the internal_error enum value from the response property for the response status

    • info

      removed the internal_error enum value from the response property for the response status

    • info

      removed the internal_error enum value from the response property for the response status

    • info

      removed the internal_error enum value from the response property for the response status

    • info

      removed the invalid_api_key enum value from the response property for the response status

    • info

      removed the invalid_api_key enum value from the response property for the response status

    • info

      removed the invalid_api_key enum value from the response property for the response status

    • info

      removed the invalid_api_key enum value from the response property for the response status

    • info

      removed the invalid_api_key enum value from the response property for the response status

    • info

      removed the invalid_api_key_format enum value from the response property for the response status

    • info

      removed the invalid_api_key_format enum value from the response property for the response status

    • info

      removed the invalid_api_key_format enum value from the response property for the response status

    • info

      removed the invalid_api_key_format enum value from the response property for the response status

    • info

      removed the invalid_api_key_format enum value from the response property for the response status

    • info

      removed the invalid_reference enum value from the response property for the response status

    • info

      removed the invalid_reference enum value from the response property for the response status

    • info

      removed the invalid_reference enum value from the response property for the response status

    • info

      removed the invalid_reference enum value from the response property for the response status

    • info

      removed the invalid_reference enum value from the response property for the response status

    • info

      removed the invalid_request_error enum value from the response property for the response status

    • info

      removed the invalid_request_error enum value from the response property for the response status

    • info

      removed the invalid_request_error enum value from the response property for the response status

    • info

      removed the invalid_request_error enum value from the response property for the response status

    • info

      removed the invalid_request_error enum value from the response property for the response status

    • info

      removed the invalid_session enum value from the response property for the response status

    • info

      removed the invalid_session enum value from the response property for the response status

    • info

      removed the invalid_session enum value from the response property for the response status

    • info

      removed the invalid_session enum value from the response property for the response status

    • info

      removed the invalid_session enum value from the response property for the response status

    • info

      removed the missing_api_key enum value from the response property for the response status

    • info

      removed the missing_api_key enum value from the response property for the response status

    • info

      removed the missing_api_key enum value from the response property for the response status

    • info

      removed the missing_api_key enum value from the response property for the response status

    • info

      removed the missing_api_key enum value from the response property for the response status

    • info

      removed the organization_required enum value from the response property for the response status

    • info

      removed the organization_required enum value from the response property for the response status

    • info

      removed the organization_required enum value from the response property for the response status

    • info

      removed the organization_required enum value from the response property for the response status

    • info

      removed the organization_required enum value from the response property for the response status

    • info

      removed the parameter_invalid enum value from the response property for the response status

    • info

      removed the parameter_invalid enum value from the response property for the response status

    • info

      removed the parameter_invalid enum value from the response property for the response status

    • info

      removed the parameter_invalid enum value from the response property for the response status

    • info

      removed the parameter_invalid enum value from the response property for the response status

    • info

      removed the parameter_missing enum value from the response property for the response status

    • info

      removed the parameter_missing enum value from the response property for the response status

    • info

      removed the parameter_missing enum value from the response property for the response status

    • info

      removed the parameter_missing enum value from the response property for the response status

    • info

      removed the parameter_missing enum value from the response property for the response status

    • info

      removed the parameter_unknown enum value from the response property for the response status

    • info

      removed the parameter_unknown enum value from the response property for the response status

    • info

      removed the parameter_unknown enum value from the response property for the response status

    • info

      removed the parameter_unknown enum value from the response property for the response status

    • info

      removed the parameter_unknown enum value from the response property for the response status

    • info

      removed the permission_error enum value from the response property for the response status

    • info

      removed the permission_error enum value from the response property for the response status

    • info

      removed the permission_error enum value from the response property for the response status

    • info

      removed the permission_error enum value from the response property for the response status

    • info

      removed the permission_error enum value from the response property for the response status

    • info

      removed the rate_limit_error enum value from the response property for the response status

    • info

      removed the rate_limit_error enum value from the response property for the response status

    • info

      removed the rate_limit_error enum value from the response property for the response status

    • info

      removed the rate_limit_error enum value from the response property for the response status

    • info

      removed the rate_limit_error enum value from the response property for the response status

    • info

      removed the rate_limit_exceeded enum value from the response property for the response status

    • info

      removed the rate_limit_exceeded enum value from the response property for the response status

    • info

      removed the rate_limit_exceeded enum value from the response property for the response status

    • info

      removed the rate_limit_exceeded enum value from the response property for the response status

    • info

      removed the rate_limit_exceeded enum value from the response property for the response status

    • info

      removed the resource_already_exists enum value from the response property for the response status

    • info

      removed the resource_already_exists enum value from the response property for the response status

    • info

      removed the resource_already_exists enum value from the response property for the response status

    • info

      removed the resource_already_exists enum value from the response property for the response status

    • info

      removed the resource_already_exists enum value from the response property for the response status

    • info

      removed the resource_archived enum value from the response property for the response status

    • info

      removed the resource_archived enum value from the response property for the response status

    • info

      removed the resource_archived enum value from the response property for the response status

    • info

      removed the resource_archived enum value from the response property for the response status

    • info

      removed the resource_archived enum value from the response property for the response status

    • info

      removed the resource_missing enum value from the response property for the response status

    • info

      removed the resource_missing enum value from the response property for the response status

    • info

      removed the resource_missing enum value from the response property for the response status

    • info

      removed the resource_missing enum value from the response property for the response status

    • info

      removed the resource_missing enum value from the response property for the response status

    • info

      removed the side_effect_failed enum value from the response property for the response status

    • info

      removed the side_effect_failed enum value from the response property for the response status

    • info

      removed the side_effect_failed enum value from the response property for the response status

    • info

      removed the side_effect_failed enum value from the response property for the response status

    • info

      removed the side_effect_failed enum value from the response property for the response status

    • info

      removed the unsupported_operation enum value from the response property for the response status

    • info

      removed the unsupported_operation enum value from the response property for the response status

    • info

      removed the unsupported_operation enum value from the response property for the response status

    • info

      removed the unsupported_operation enum value from the response property for the response status

    • info

      removed the unsupported_operation enum value from the response property for the response status

    • info

      removed the upstream_service_error enum value from the response property for the response status

    • info

      removed the upstream_service_error enum value from the response property for the response status

    • info

      removed the upstream_service_error enum value from the response property for the response status

    • info

      removed the upstream_service_error enum value from the response property for the response status

    • info

      removed the upstream_service_error enum value from the response property for the response status

    This list may be incomplete.