Sign in
Paywalls V2

Create Paywall

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 body

application_idstring required

ID of the application to create the paywall in

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

Unique identifier for the paywall

object'paywall' required

Object type, always paywall

application_idstring required

ID of the application this paywall belongs to

project_idstring nullable required

a string to be decoded into a number

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

a string to be decoded into a number

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

Changes

No recorded changes to this endpoint across all 1 revision of this API.