MYmyclickfunnels
Page

Create External Page

Changed on

Create an externally-hosted (SDK) page. Unlike internal pages, the visual content lives on your own domain and is registered with ClickFunnels via a lightweight SDK integration.

Required fields:

  • external_url: The fully-qualified URL where your page is hosted.

Standalone vs in a funnel: the funnel block is optional.

  • Omit it to create a standalone external page: registered with an SDK token and visit tracking enabled, but not a step in any funnel. Place it later by passing its id in a conditional split's branches[].page_id, a split test's fresh-variant slot, an update swap (funnel.show_page_step_id), or the funnel attach_page flow. SDK checkout and form submission require placement and return a page_not_in_funnel error until the page is a funnel step.
  • Provide funnel.funnel_id OR funnel.show_page_step_id to create it inside a funnel in one call.

Funnel positioning:

  • funnel.funnel_id + optional sort_order: Creates a new show page step in the funnel at the specified zero-based position (0 = first, omit = append at end).
  • funnel.show_page_step_id: Swaps the existing step to point at the new external page. The previous page on that step becomes an orphan. sort_order is ignored in this case.
  • Positioning params without their funnel target return 422: sort_order requires funnel.funnel_id, and funnel.after_show_page_step_id requires funnel.funnel_id.

Rejected fields (returns 422 if present): markup, theme_id, current_path, seo_title, seo_description, seo_index, block_ai_crawler, block_ai_search, block_ai_assistant, head_code, footer_code, live_data_changes, show_page_step.product_ids, show_page_step.bumps. Attach products and order bumps in a follow-up PATCH /api/v2/pages/:id.

SDK onboarding: The response includes an sdk block with a token (prefixed cfp_). To register the page:

  1. Add <meta name="cf-page-token" content="<token>"> to your page's <head>.
  2. Include the ClickFunnels SDK script tag on the page.

The Create an External Page Skill is the end-to-end guide for the page itself. To sell products from that page, see Add Checkout to an External Page.

post/workspaces/{workspace_id}/pages/external

Request

Path parameters

workspace_idstring required

Request body

Response

Created

idinteger

Page ID

public_idstring

The public identifier of the page

workspace_idinteger

Workspace ID that the page belongs to.

namestring

Page name of the editable page element. Want to filter by it? See our <i><u><a href="https://developers.myclickfunnels.com/docs/filtering-by-page" target="_blank">help guide on that topic</a><u><i>.

descriptionstring nullable

A short description of the page (max 1000 characters).

theme_idinteger nullable

Theme

created_atstring date-time

Created at

seo_titlestring nullable

Custom title for search engine results. Falls back to the site's SEO title if not set.

seo_descriptionstring nullable

Custom meta description for search engine results. Falls back to the site's SEO description if not set.

seo_indexboolean

Whether search engines should index this page. Defaults to false.

block_ai_crawlerboolean

Whether AI training crawlers (GPTBot, ClaudeBot, Google-Extended, Applebot-Extended, CCBot and others) are blocked from using this page's content to train models. Defaults to false. Enforced by a Disallow rule in the domain's robots.txt — see Crawler access (AI opt-out) in the Pages Skill for coverage limits. Independent of seo_index and of the other two AI flags.

block_ai_searchboolean

Whether AI answer engines (OAI-SearchBot, Claude-SearchBot, PerplexityBot and others) are blocked from indexing this page and citing it when people ask questions. Defaults to false. Enforced via robots.txt. See Crawler access (AI opt-out) in the Pages Skill for coverage limits.

block_ai_assistantboolean

Whether AI assistants (ChatGPT-User, Claude-User, Perplexity-User and others) are blocked from opening this page when a person asks them to — for example pasting the page's link into a chat. Defaults to false. Enforced via robots.txt. See Crawler access (AI opt-out) in the Pages Skill for coverage limits.

updated_atstring date-time

Updated at

type'landing_page' | 'site_page' | 'funnel_page' | 'theme_page' | 'null' nullable

The type of page. Can be one of landing_page, site_page, funnel_page or theme_page. May be null for a page that matches none of these categories.

custom_html_pageboolean

Whether this is a ClickFunnels-hosted custom HTML page — a page whose entire body is author-supplied HTML served verbatim (no page editor, no PML). Read the HTML via GET /pages/{id}/custom_html and replace it by sending the write-only custom_html string on PATCH /pages/{id}. Create these via POST /workspaces/{workspace_id}/pages/custom_html. (Deliberately named differently from the custom_html request field so echoing a GET payload back into PATCH never collides.)

current_pathstring nullable

The current URL path for the page resource. This is the canonical URL for landing and site pages. null for externally-hosted (SDK) pages. For funnel pages this is NOT the customer-facing URL — that's url (or show_page_step.current_path for the path component). The page-level current_path on a funnel page does not route the visitor through the workflow step, so a <checkout/> element on it will not see the step's attached products. See Setting a page's path (current_path) in the Pages Skill.

urlstring nullable

The customer-facing URL for the page on the live site. For funnel pages this routes through the workflow step (which feeds <checkout/> its IncludedProducts). Always prefer this over current_path when constructing links.

head_codestring nullable

Expandable Custom HTML/JavaScript code injected into the page 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.

custom_cssstring nullable

Expandable Raw CSS applied at the page level (no <style> wrapper). Maps to the CSS tab in the page editor's Code Editor panel. Internal pages only. Only returned when expand[]=custom_css is provided. Note: expanding may add latency, especially on list endpoints. Use sparingly.

markupstring

Expandable The PML (Page Markup Language) representation of the page's visual tree. Only returned when expand[]=markup is provided. Note: expanding may add latency, especially on list endpoints. This serialization is lossy: elements PML has no equivalent for are omitted with no error and no placeholder, so a round-tripped read is not a safe basis for rewriting a page (see the approval guardrail). An empty string therefore does not prove the page is empty: a page built entirely from elements PML cannot express also reads back empty. The value <!-- markup unavailable: page tree could not be serialized --> means the read failed; treat the page as unreadable and do not write that string back. See the Page Markup Skill for the full DSL reference.

Example response

{
  "id": 9,
  "public_id": "kJzvQi",
  "workspace_id": 42000,
  "name": "Great Page",
  "description": "A high-converting sales page",
  "theme_id": null,
  "seo_title": "Great Page - My Brand",
  "seo_description": "Learn more about our amazing offer",
  "seo_index": true,
  "block_ai_crawler": false,
  "block_ai_search": false,
  "block_ai_assistant": false,
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z",
  "type": "funnel_page",
  "custom_html_page": false,
  "current_path": "/my-page-canonical",
  "url": "https://myteam.myclickfunnels.com/my-funnel-page",
  "show_page_step": {
    "id": 42,
    "public_id": "aBcDeF",
    "name": "Best Page Step",
    "current_path": "/my-funnel-page",
    "sort_order": 0,
    "products": []
  },
  "funnel": {
    "id": 123,
    "public_id": "xYzAbC",
    "name": "My Sales Funnel"
  },
  "sdk": null,
  "markup": "<section>\n  <row cols=\"1\">\n    <column>\n      <headline>Great Page</headline>\n      <subheadline>Start your journey here</subheadline>\n    </column>\n  </row>\n</section>\n"
}

Changes

  • 511d88b30aeaRevision changes
    • info

      for the path request parameter workspace_id, the type was generalized from integer to string

    • info

      removed the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

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

    • info

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