Pages

List All Pages

Retrieve all pages for a project.

string

required

The brand/project ID

Request

GET /api/brands/{brand}/pages/all

cURL

curl https://app.elasticfunnels.io/api/brands/{brand_id}/pages/all \
  -H "EF-Access-Key: your_api_key_here"

{
  "data": [
    {
      "id": 1,
      "name": "Landing Page",
      "slug": "landing-page",
      "status": "active",
      "type": "landing",
      "created_at": "2024-01-15T10:30:00.000000Z"
    },
    {
      "id": 2,
      "name": "Thank You Page",
      "slug": "thank-you",
      "status": "active",
      "type": "thankyou",
      "created_at": "2024-01-16T11:20:00.000000Z"
    }
  ]
}

Get Page Details

Retrieve details about a specific page.

string

required

The brand/project ID

string

required

The page ID

Request

GET /api/brands/{brand}/pages/{page}

cURL

curl https://app.elasticfunnels.io/api/brands/{brand_id}/pages/{page_id} \
  -H "EF-Access-Key: your_api_key_here"

{
  "id": 1,
  "name": "Landing Page",
  "slug": "landing-page",
  "status": "active",
  "type": "landing",
  "meta_title": "Amazing Product",
  "meta_description": "Get your product now",
  "url": "https://yourdomain.com/landing-page",
  "created_at": "2024-01-15T10:30:00.000000Z",
  "updated_at": "2024-12-10T08:20:00.000000Z"
}

Create Page

Create a new page.

string

required

The brand/project ID

string

required

Page title

string

Page builder type: must be editor (optional if html is provided, required otherwise)

string

URL-friendly slug (optional, auto-generated if not provided)

string

Page status: published, draft, offline, imported (default: draft)

string

Raw HTML content (automatically sets page_type to editor). If this HTML contains <inline-split-test>, the Pages API stores that source markup as provided.

number

Custom domain ID (optional)

number

Funnel ID to associate with (optional)

number

Folder ID to organize page (optional)

boolean

Set as index page (default: false)

string

Custom CSS styles

string

Template type: nutra-prelander, nutra-advertorial, leadgen, webinar-registration

string

Template ID to use (optional)

string

SEO meta title

string

Alternative title when tab is not focused

string

SEO meta description

Require user login to access

boolean

Require password to access

string

Page password (required if requires_password is true)

string

URL to redirect to

string

Google Analytics measurement ID

string

Meta (Facebook) Pixel ID

string

Custom JavaScript code

boolean

Mark as upsell page

boolean

Show affiliate tracking pixels

boolean

Disable default tracking scripts

Request

POST /api/brands/{brand}/pages

Create Basic Page

cURL

curl -X POST https://app.elasticfunnels.io/api/brands/{brand_id}/pages \
  -H "EF-Access-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "New Landing Page",
    "slug": "new-landing",
    "page_type": "editor",
    "status": "published"
  }'

Create Page with HTML

cURL

curl -X POST https://app.elasticfunnels.io/api/brands/{brand_id}/pages \
  -H "EF-Access-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Custom HTML Page",
    "slug": "custom-page",
    "status": "published",
    "html": "<!DOCTYPE html><html><head><title>My Page</title></head><body><h1>Hello World</h1></body></html>",
    "css": "body { background: #f5f5f5; font-family: Arial, sans-serif; }"
  }'

When you provide html in the request, page_type is automatically set to editor, so you don’t need to specify it
The API only supports editor type pages. The visual drag-and-drop builder is available only through the web dashboard
On update, providing html will automatically convert the page to editor type if it isn’t already
If your html contains <inline-split-test>, the create/update response returns stored source HTML, not the runtime-resolved winning variant HTML

{
  "id": 3,
  "title": "New Landing Page",
  "slug": "new-landing",
  "status": "published",
  "page_type": "editor",
  "url": "https://yourdomain.com/new-landing",
  "created_at": "2024-12-10T15:45:00.000000Z"
}

Inline Split Test HTML in Pages API

When you send <inline-split-test> markup through POST /api/brands/{brand}/pages or PUT /api/brands/{brand}/pages/{page}:

The endpoint stores the full source HTML you send in html
The response does not replace the tag with the chosen runtime variant
The public Pages API does not inject the auto-managed id attribute during create/update

Example request body:

{
  "title": "Split Test Page",
  "slug": "split-test-page",
  "status": "published",
  "html": "<inline-split-test name=\"Headline Test\"><variant name=\"control\" weight=\"70\"><h1>Original Headline</h1></variant><variant name=\"challenger\" weight=\"30\"><h1>New Headline</h1></variant></inline-split-test>"
}

Example create response shape:

Response

{
  "page": {
    "id": 12,
    "title": "Split Test Page",
    "slug": "split-test-page",
    "status": "published",
    "page_type": "editor",
    "html": "<inline-split-test name=\"Headline Test\"><variant name=\"control\" weight=\"70\"><h1>Original Headline</h1></variant><variant name=\"challenger\" weight=\"30\"><h1>New Headline</h1></variant></inline-split-test>"
  }
}

Runtime rendering is different from the API response. When a visitor loads the page, the server replaces the entire block with the chosen variant wrapped like this:

<div data-sid="[split_test_id]" data-cid="[variant_code]">
  <!-- Full HTML of the chosen variant -->
</div>

If you use a save flow that returns normalized inline split test HTML with a server-generated id, replace your local/source HTML with that returned HTML before the next update. This only matters when your next request includes html again. If html is omitted because nothing changed, the existing stored HTML stays unchanged. Re-sending the original <inline-split-test> markup without the injected id in a later html update can cause the server to create a new split test record on every save.

Update Page

Update an existing page. Only include the fields you want to change.

Common causes of errors on PUT/PATCH:

Symptom	Cause	Fix
`422` with `title is required`	`title` is always required by the validator, even if you’re only changing HTML	Always include `"title"` in the body
`401` / redirect to login	Missing or invalid `EF-Access-Key` header, or key doesn’t belong to this brand	Check the header name (`EF-Access-Key`) and value
`403` module access	Brand user role doesn’t have `pages` access	Update role permissions in Project Settings
Slug `422` uniqueness error	Provided `slug` already exists for another page on the same domain	Choose a unique slug or omit it

string

required

The brand/project ID

string

required

The page ID

string

required

Page title

string

URL-friendly slug

string

Page status: published, draft, offline, imported

number

Custom domain ID

number

Folder ID to organize page

boolean

Set as index page

string

Raw HTML content (automatically sets page_type to editor). If this HTML contains <inline-split-test>, the Pages API stores that source markup as provided.

string

Custom CSS styles

string

SEO meta title

string

Alternative title when tab is not focused

string

SEO meta description

Require user login to access

boolean

Require password to access

string

Page password

string

URL to redirect to

boolean

Disable right-click on page

boolean

Prevent search engine indexing

boolean

Only accessible through funnel flow

string

Google Analytics measurement ID

string

Meta (Facebook) Pixel ID

string

Custom header code

string

Custom JavaScript code (must be valid script tags only)

boolean

Mark as upsell page

boolean

Show affiliate tracking pixels

boolean

Disable default tracking scripts

Request

PUT /api/brands/{brand}/pages/{page}

Update Basic Information

cURL

curl -X PUT https://app.elasticfunnels.io/api/brands/{brand_id}/pages/{page_id} \
  -H "EF-Access-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Updated Page Name",
    "status": "published"
  }'

Update page title and status

cURL

curl -X PUT https://app.elasticfunnels.io/api/brands/{brand_id}/pages/{page_id} \
  -H "EF-Access-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Updated Page Name",
    "status": "published"
  }'

Update HTML content

cURL

curl -X PUT https://app.elasticfunnels.io/api/brands/{brand_id}/pages/{page_id} \
  -H "EF-Access-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "My Custom Page",
    "html": "<!DOCTYPE html><html><body><h1>Updated Content</h1></body></html>",
    "css": "body { font-family: Arial; }"
  }'

Providing html automatically converts the page to editor type if it isn’t already.

Update SEO settings

cURL

curl -X PUT https://app.elasticfunnels.io/api/brands/{brand_id}/pages/{page_id} \
  -H "EF-Access-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "My Landing Page",
    "seo_title": "Best Product Ever - Buy Now",
    "seo_description": "Discover the amazing benefits of our product",
    "prevent_indexing": false
  }'

{
  "id": 3,
  "brand_id": 42,
  "title": "My Custom Page",
  "slug": "my-custom-page",
  "status": "published",
  "page_type": "editor",
  "html": "<!DOCTYPE html><html><body><h1>Updated Content</h1></body></html>",
  "css": "body { font-family: Arial; }",
  "seo_title": "My Custom Page",
  "seo_description": null,
  "domain_id": null,
  "folder_id": null,
  "updated_at": "2024-12-11T09:15:00.000000Z"
}

{
  "errors": {
    "title": ["The title field is required."]
  }
}

{
  "errors": {
    "slug": ["The slug has already been taken."]
  }
}

{
  "message": "Invalid API key or brand access denied"
}

Page Types and Fields

API Page Type: Editor Only

The API only supports creating editor pages. The visual drag-and-drop builder is only available through the web dashboard interface.

Editor Pages allow direct HTML/CSS editing through the API:

html - Raw HTML content
css - Custom CSS styles
page_type - Must be editor (or automatically set when html is provided)

Automatic Editor Type Assignment

When you provide the html field in a create or update request, the page is automatically set to editor type, even if you don’t specify page_type.

{
  "title": "My Page",
  "html": "<html>...</html>"
  // page_type is automatically set to "editor"
}

Update Behavior

When updating pages:

Only provided fields are updated - omitted fields remain unchanged
html field is updated if provided in the request
css field is updated if provided in the request
Providing html will automatically set/update page_type to editor
Empty strings will clear the field value

Custom JavaScript Validation

The custom_javascript field must contain only valid <script> tags. HTML comments and <noscript> tags are allowed.

<!-- Valid -->
<script>
  console.log('Hello World');
</script>

<!-- Invalid - contains non-script elements -->
<div>Some content</div>
<script>console.log('test');</script>

Delete Page

Delete a page.

string

required

The brand/project ID

string

required

The page ID

Request

DELETE /api/brands/{brand}/pages/{page}

cURL

curl -X DELETE https://app.elasticfunnels.io/api/brands/{brand_id}/pages/{page_id} \
  -H "EF-Access-Key: your_api_key_here"

{
  "message": "Page deleted successfully"
}

Plan Limits and Errors

When creating pages, the API checks against your plan limits:

Plan Limit Exceeded Error

{
  "error": "Plan limit exceeded",
  "plan_error": {
    "type": "plan_limit_exceeded",
    "feature": "pages",
    "message": "You have reached the maximum number of pages (10) allowed for your plan.",
    "current_count": 10,
    "limit": 10,
    "plan_name": "Starter",
    "upgrade_info": {
      "required_plan": "Professional",
      "feature_description": "Unlimited pages"
    }
  },
  "errors": {
    "title": ["You have reached the maximum number of pages (10) allowed for your plan. Please upgrade to create more pages."]
  }
}

Status Code: 422 Unprocessable Entity

Plan Feature Not Available Error

{
  "error": "Plan limit exceeded",
  "plan_error": {
    "type": "plan_upgrade_required",
    "feature": "pages",
    "message": "Your current plan does not allow creating pages.",
    "plan_name": "Free Trial",
    "upgrade_info": {
      "required_plan": "Starter",
      "feature_description": "Create landing pages"
    }
  },
  "errors": {
    "title": ["Your current plan does not allow creating pages. Please upgrade to access this feature."]
  }
}

Status Code: 422 Unprocessable Entity

Clone Page

Create a copy of an existing page.

string

required

The brand/project ID

string

required

The page ID to clone

string

Name for the cloned page (optional, defaults to “Copy of [original name]”)

Request

POST /api/brands/{brand}/pages/{page}/clone

cURL

curl -X POST https://app.elasticfunnels.io/api/brands/{brand_id}/pages/{page_id}/clone \
  -H "EF-Access-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Cloned Landing Page"
  }'

{
  "id": 4,
  "name": "Cloned Landing Page",
  "slug": "cloned-landing-page",
  "status": "inactive",
  "type": "landing",
  "created_at": "2024-12-10T16:00:00.000000Z"
}

Getting Started

Endpoints

List All Pages

Get Page Details

Create Page

Create Basic Page

Create Page with HTML

Inline Split Test HTML in Pages API

Update Page

Update Basic Information

Update page title and status

Update HTML content

Update SEO settings

Page Types and Fields

API Page Type: Editor Only

Automatic Editor Type Assignment

Update Behavior

Custom JavaScript Validation

Delete Page

Plan Limits and Errors

Plan Limit Exceeded Error

Plan Feature Not Available Error

Clone Page

​List All Pages

​Get Page Details

​Create Page

​Create Basic Page

​Create Page with HTML

​Inline Split Test HTML in Pages API

​Update Page

​Update Basic Information

​Update page title and status

​Update HTML content

​Update SEO settings

​Page Types and Fields

​API Page Type: Editor Only

​Automatic Editor Type Assignment

​Update Behavior

​Custom JavaScript Validation

​Delete Page

​Plan Limits and Errors

​Plan Limit Exceeded Error

​Plan Feature Not Available Error

​Clone Page

List All Pages

Get Page Details

Create Page

Create Basic Page

Create Page with HTML

Inline Split Test HTML in Pages API

Update Page

Update Basic Information

Update page title and status

Update HTML content

Update SEO settings

Page Types and Fields

API Page Type: Editor Only

Automatic Editor Type Assignment

Update Behavior

Custom JavaScript Validation

Delete Page

Plan Limits and Errors

Plan Limit Exceeded Error

Plan Feature Not Available Error

Clone Page