Create a new landing page

Creates a new landing page within the given subscriber list (newsletter). The same
business logic used by the admin UI editor is applied (deadline computation, password
protection field setup, link monitoring, activity logging), so the result is identical
to creating the page through the UI.

Deadline

The optional deadline object controls whether (and how) the landing page expires:

typeDescription
0No deadline (default)
1Fixed date/time — requires date, hour, min
2Relative to a list field's date value (redirect on reaching it) — requires field, relativeDays
3Relative to a list field's date value (same as 2, different presentation) — requires field, relativeDays
4Relative countdown from first visit — requires relativeHour, relativeMin

For type: 2 or type: 3, field must be an existing field on the landing page's subscriber list.

Password protection

Password protection cannot be set through this API — passwordProtection is a read-only
field on the response, reflecting whatever was configured for the page through the admin
UI editor. New/updated landing pages are always created without password protection.

External URL

externalUrlTypeDescription
0Auto-generated random URL path (default)
1Custom URL path — supply it via externalUrl

HTML content

If htmlContent is provided, it is saved as the landing page's source and trackingCodes
(if any) are merged with the defaults. If htmlContent is omitted, the landing page is
created without a source (e.g. to be edited later via the visual builder).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Subscriber list (newsletter) ID

Body Params

Request body for creating a landing page.

string
required

Landing page name (displayed in the admin interface)

string

Heading text displayed at the top of the rendered landing page.

integer
Defaults to 0

Landing page folder ID to place the page in. 0 (default) means no folder.

integer

Landing page template ID to apply during HTML generation. If omitted, no template is applied.

integer

Subdomain the landing page is published under.

integer
enum
Defaults to 0
  • 0 — auto-generated random URL path (default)
  • 1 — custom URL path, supplied via externalUrl
Allowed:
string

Custom URL path. Required and used only when externalUrlType is 1.

boolean
Defaults to false

Whether outbound links on the landing page are monitored for click tracking.

integer
enum
Defaults to 0

Whether a sub landing page inherits the password-protection segments of its main page (0 or 1).

Allowed:
integer
Defaults to 0

ID of the main landing page this page is a step of, for multi-step landing pages. 0 means this is not a sub-page.

boolean

Whether this landing page becomes the default page served for its subdomain.

deadline
object

Controls whether and how the landing page expires. Which sub-fields are required depends
on type.

string

Full HTML source of the landing page. If omitted, the landing page is created without
a source (e.g. to be edited later via the visual builder). Mutually exclusive with htmlContentUrl.

uri

Alternative to htmlContent: a publicly reachable HTTPS URL the server fetches the HTML content
from server-side. Use this to upload large or externally-authored HTML verbatim without including
it in the request body. Mutually exclusive with htmlContent. The URL must resolve to a public,
non-private IP address; the fetched content is capped at 2MB.

trackingCodes
object

Custom tracking/analytics code snippets injected into the generated landing page HTML.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json