Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB
Funnel

Create Funnel

Create a new funnel in the workspace.

Creating a funnel automatically creates a workflow. You can then add pages to the funnel by creating pages with funnel.funnel_id set to the new funnel's ID (see the Create Page endpoint).

Client flow for building a funnel with pages:

  1. POST /api/v2/workspaces/:id/funnels — creates the funnel (workflow auto-created)
  2. POST /api/v2/workspaces/:id/pages with { page: { name: "...", funnel: { funnel_id: "<funnel_id>" }, markup: "<PML string>" } } — creates each page, auto-links it to the funnel, and applies the markup in one call
  3. PATCH /api/v2/pages/:id with { page: { markup: "<PML string>" } } — applies or updates visual content (PML markup) on an existing page
  4. Steps 2 and 3 can be combined: passing markup in the create call sets the initial visual content without a separate PATCH

The internal step/workflow wiring is handled automatically — API clients never need to manage workflows or steps directly.

post/workspaces/{workspace_id}/funnels

Path parameters

workspace_idinteger required

Request body

Example request

{
  "funnel": {
    "funnel": {
      "name": "Example Funnel",
      "current_path": "/example-funnel",
      "live_mode": true,
      "tag_ids": [
        1,
        2
      ]
    }
  }
}

Response

Created

idinteger

Funnel ID

public_idstring

The public identifier of the funnel

workspace_idinteger

The ID of the workspace that the funnel belongs to

namestring

Name of the Funnel

archivedboolean

Archived status

current_pathstring

The URL path of the funnel

live_modeboolean

In Live Mode your Funnel cannot be tested and will process live payments

domain_idinteger nullable

The ID of the domain associated with this funnel. Use the Domains API to look up available domain IDs.

favicon_image_idstring nullable

The ID of the image used as the favicon for this funnel

created_atstring date-time

Created at

updated_atstring date-time

Updated at

head_codestring nullable

Expandable Custom HTML/JavaScript code injected into the funnel head section. Only returned when expand[]=head_code is provided. Note: expanding may add latency, especially on list endpoints. Use sparingly.

footer_codestring nullable

Expandable Custom HTML/JavaScript code injected before the closing body tag. Only returned when expand[]=footer_code is provided. Note: expanding may add latency, especially on list endpoints. Use sparingly.

Example response

{
  "id": 1,
  "public_id": "gESyMv",
  "workspace_id": 42000,
  "name": "Example Funnel",
  "archived": false,
  "current_path": "/example-path",
  "live_mode": true,
  "domain_id": 42,
  "favicon_image_id": null,
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z",
  "tags": [
    {
      "id": 1,
      "public_id": "JgjGTv",
      "name": "Example Funnel Tag",
      "color": "#00FF00"
    }
  ]
}