SUsuperwall
Paywalls V2

Create Paywall

Changed on

Creates a new paywall in the specified application. Optionally create from a template by providing the template field, or create a self-hosted paywall by providing url. Self-hosted url cannot be combined with template. Requires paywalls:write scope.

post/v2/paywalls

Request

  • Base URL
    https://api.superwall.com
  • URL
    https://api.superwall.com/v2/paywalls
  • 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 paywall

identifierstring

URL-safe identifier (slug). Auto-generated from name if not provided

urlstring

Canonical self-hosted paywall URL for non-template creates. Cannot be combined with template.

templatestring

ID of the template to create the paywall from

metadataobject

Arbitrary key-value metadata to attach to the paywall

headlessboolean

Creates a code-first (headless) paywall, authored with the superwall framework and updated with superwall push / superwall promote rather than the visual editor. Fixed at creation: existing paywalls cannot be converted, and headless paywalls cannot be opened in the editor. Cannot be combined with template.

Response

Success

idstring required
object'paywall' required

Object type, always paywall

application_idstring required
project_idstring nullable required

ID of the project containing the paywall's application, or null

namestring required

Display name of the paywall

identifierstring required

URL-safe identifier (slug) for the paywall

paywall_urlstring required

URL to the interactive paywall

versionnumber required

Current published version number

headlessboolean required

Whether this is a code-first (headless) paywall, authored with the superwall framework and shipped with superwall push / superwall promote rather than the visual editor. A headless paywall with version: 0 has been pushed but never promoted, so it has no live snapshot and cannot back a campaign variant.

source_templatestring nullable required

ID of the template this paywall was created from, or null

created_atstring required

ISO 8601 timestamp of when the paywall was created

updated_atstring required

ISO 8601 timestamp of when the paywall was last updated

published_atstring nullable required

ISO 8601 timestamp of when the paywall was last published, or null

archivedboolean required

Whether the paywall is archived

metadataobject required
preview_urlstring nullable required

URL to a preview screenshot of the paywall, or null

legacy_editor'v2' | 'v3'

Present only on paywalls built in the legacy (pre-v4) editor, which are returned only when listing with include_legacy_editor=true. Names the legacy editor that opens the paywall.

Changes

  • 523b4734dfabRevision changes
    • info

      added the new optional request property ///

    • info

      added the optional property // to the response with the status

  • 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

    • info

      added subschema #1 subschema #2 to the response body anyOf list 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

      added subschema #2 subschema #3 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 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

    • info

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