Skip to main content
POST
Add a page

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, an opaque member token, or a verified One Auth identity access token. The credential alone identifies the member and company. Member session and portal JWTs are read-only and are refused with 403 on every write.

Path Parameters

site_id
string<uuid>
required

Public id of one of the member's sites.

Body

application/json

A new page. Fields a member cannot set are refused as unknown fields.

slug
string
required

Lowercase letters and digits separated by single hyphens, unique in the site, or / for the home page. index is reserved for the home page.

Required string length: 1 - 255
Pattern: ^(/|[a-z0-9]+(-[a-z0-9]+)*)$
title
string
required

Display title.

Required string length: 1 - 255
Pattern: ^[^\u0000]*[^\s\u0000][^\u0000]*$
position
integer

Order of the page among the site's pages. Defaults to 0.

published
boolean

Whether the page is shown once the site is published. Defaults to false.

layout_name
string | null

The layout this page uses. Null or omitted uses the site's default.

Maximum string length: 255
menu
string | null

The slug of one of the site's own menus. A menu of another site is refused. Null or omitted assigns none.

Maximum string length: 255
content
string

The page's content, kept in the site file pages/<slug>.liquid. Empty by default.

Pattern: ^[^\u0000]*$

Response

The new page.

One page.

status
integer
required

HTTP status code (mirrors the response status line).

data
object
required

One page of a site. Its content is the site file pages/<slug>.liquid, not part of the page.

meta
object
required

Envelope metadata present on every response.