Pages

Pages endpoints of the Zanfia Workspace API, with schemas and code samples.

7 min readLast updated Sep 10, 2026

Custom hosted HTML pages on your storefront domain. Requires the pages:read / pages:write scopes. All routes require a Authorization: Bearer header — see Authentication.

List pages

GET/pages

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

slug*string

title*string

html*string

Raw HTML body to host.

seo?

publish?boolean

Publish immediately; defaults to false (draft).

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

POST /pages/generate — the same body the dashboard's page wizard sends; the acting user and workspace come from the API key. Generation is async: the response carries a run handle, the page itself lands later.

intent*PageGenerationIntent

What job the page is for — picks the prompt framing and template pool.

Value in

"lead-magnet"
"webinar"
"sales-page"
"thank-you"
"waitlist"
"newsletter"
"challenge"
"application"
"generic"

brief*string

Free-text description of the page. Facts included here (price, date, links) are used verbatim.

templateId?string

Optional HTML template seed from @zanfia/page-templates — strong design prior. Omit for freeform.

palette?PagePalette

Whose colors the page carries. Defaults to template when templateId names a real template, brand otherwise. Ignored for companions and source-site rebuilds (they inherit their reference).

Value in

"template"
"brand"
"custom"

paletteColors?

The creator's own accent + background for palette: custom.

productId?string

Optional grounding product — its real name/description/prices plus a checkout link / signup-form embed are injected as verbatim facts.

productRole?PageProductRole

What the product is to this page (offer sells it, destination = the page leads to it). Defaults by intent.

Value in

"offer"
"destination"

formId?string

Optional standalone signup form — its /embed/form/… snippet is injected as the page's signup CTA (works with or without a grounding product; overrides a product-bound form embed when both are present).

checkoutId?string

Overrides the product's default checkout as the grounding offer.

sourceUrl?string

Optional website to start from — fetched server-side and injected as the design/content reference. Takes precedence over templateId.

sourceSiteMode?PageSourceSiteMode

How the source website is used — required when sourceUrl is set.

Value in

"rebuild"
"inspired"

title*string

slug?string

Derived from title when omitted; conflicts get a numeric suffix.

deliveryUrl?string

What the signup delivers (lead magnet file URL / webinar join link) — seeds the draft delivery automation's email. Never printed on the page.

deliveryName?string

Human name of the deliverable for the delivery email copy.

eventStartAt?string

Webinar pages: the event start as an ISO 8601 timestamp WITH offset (2026-09-12T19:00:00+02:00). Enables add-to-calendar links and the reminder/replay follow-up ladder.

eventTimezone?string

IANA timezone the event was scheduled in (e.g. Europe/Warsaw).

eventDurationMinutes?number

Event length in minutes; defaults to 60.

eventMode?PageEventMode

Webinar pages: on_demand = autowebinar (no date, the recording plays right after signup).

Value in

"live"
"on_demand"

replayMediaId?string

On-demand webinar: Media Library video id the room page plays.

optInMode?FormOptInMode

Opt-in mode of the auto-provisioned signup form; defaults to single.

Value in

"double"
"single"

formTagIds?array<string>

Tags the auto-provisioned signup form applies to subscribers (ignored when formId is set).

parentPageId?string

Companion of an existing page: inherits its design, links to it, joins its funnel.

Response Body

`application/json`

curl -X POST "https://example.com/pages/generate" \  -H "Content-Type: application/json" \  -d '{    "intent": "lead-magnet",    "brief": "string",    "title": "string"  }'

{  "runId": "string",  "publicAccessToken": "string"}

{  "error": "string",  "message": "string"}

List page design templates

GET/page-templates

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Query Parameters

category?string

Only templates of this intent category.

Response Body

`application/json`

curl -X GET "https://example.com/page-templates"

{  "count": 0,  "templates": [    {      "id": "string",      "name": "string",      "category": "string",      "description": "string",      "directUse": true    }  ]}

{  "error": "string",  "message": "string"}

Page detail

GET/pages/{pageId}

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

pageId*string

Page id

Response Body

`application/json`

curl -X GET "https://example.com/pages/string"

{  "id": "string",  "slug": "string",  "title": "string",  "status": "draft",  "source": "pasted",  "publishedAt": "string",  "createdAt": "string",  "updatedAt": "string",  "html": "string",  "seo": {    "title": "string",    "description": "string",    "noindex": true  }}

{  "error": "string",  "message": "string"}

Update a page

PATCH/pages/{pageId}

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

pageId*string

Page id

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

slug?string

title?string

html?string

seo?

Response Body

`application/json`

curl -X PATCH "https://example.com/pages/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "pageId": "string"}

{  "error": "string",  "message": "string"}

Delete a page

DELETE/pages/{pageId}

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

pageId*string

Page id

Response Body

`application/json`

curl -X DELETE "https://example.com/pages/string"

{  "pageId": "string"}

{  "error": "string",  "message": "string"}

Publish or unpublish a page

POST/pages/{pageId}/publish

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

pageId*string

Page id

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

publish*boolean

Response Body

`application/json`

curl -X POST "https://example.com/pages/string/publish" \  -H "Content-Type: application/json" \  -d '{    "publish": true  }'

{  "pageId": "string",  "status": "draft"}

{  "error": "string",  "message": "string"}

Edit a page with AI

POST/pages/{pageId}/edit

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

pageId*string

Page id

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

POST /pages/{pageId}/edit — AI-edits the page's current HTML from an edit brief (the same contract the Creator Assistant's edit-page tool uses).

instructions*string

What to change and where on the page, in the creator's words, with every real fact the change needs (names, prices, dates, links) stated verbatim. Batch several changes into one brief.

Response Body

`application/json`

curl -X POST "https://example.com/pages/string/edit" \  -H "Content-Type: application/json" \  -d '{    "instructions": "string"  }'

{  "pageId": "string",  "edited": true}

{  "error": "string",  "message": "string"}

List page revisions

GET/pages/{pageId}/revisions

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

pageId*string

Page id

Response Body

`application/json`

curl -X GET "https://example.com/pages/string/revisions"

{  "revisions": [    {      "id": "string",      "createdAt": "string",      "source": "ai-edit",      "sizeBytes": 0    }  ]}

{  "error": "string",  "message": "string"}

Restore a page revision

POST/pages/{pageId}/revisions/{revisionId}/restore

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

pageId*string

Page id

revisionId*string

Response Body

`application/json`

curl -X POST "https://example.com/pages/string/revisions/string/restore"

{  "pageId": "string",  "revisionId": "string",  "restored": true}

{  "error": "string",  "message": "string"}

Activate the automations generated for a page

POST/pages/{pageId}/activate-automations

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

pageId*string

Page id

Response Body

`application/json`

curl -X POST "https://example.com/pages/string/activate-automations"

{  "delivery": {    "automationId": "string",    "status": "activated"  },  "followUps": [    {      "kind": "day_before",      "broadcastId": "string",      "sendAt": 0,      "status": "activated"    }  ]}

{  "error": "string",  "message": "string"}

Set or clear the storefront main page

PUT/pages/main

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Set (or clear) the storefront's main page. pageId = a Published page's id to render at the storefront root; null reverts to the product storefront.

pageId*string|null

Response Body

`application/json`

curl -X PUT "https://example.com/pages/main" \  -H "Content-Type: application/json" \  -d '{    "pageId": "string"  }'

{  "mainPageId": "string"}

{  "error": "string",  "message": "string"}

Was this article helpful?

Spotted something off? Tell us at support@zanfia.com.

List pages

200application/json

4XXapplication/json

Create a page

200application/json

4XXapplication/json

Generate a page with AI

200application/json

4XXapplication/json

List page design templates

200application/json

4XXapplication/json

Page detail

200application/json

4XXapplication/json

Update a page

200application/json

4XXapplication/json

Delete a page

200application/json

4XXapplication/json

Publish or unpublish a page

200application/json

4XXapplication/json

Edit a page with AI

200application/json

4XXapplication/json

List page revisions

200application/json

4XXapplication/json

Restore a page revision

200application/json

4XXapplication/json

Activate the automations generated for a page

200application/json

4XXapplication/json

Set or clear the storefront main page

200application/json

4XXapplication/json

Related articles

API overview

Authentication and API keys

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`