Skip to main content
POST
Add a site

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.

Body

application/json

A new site. Fields a member cannot set, such as required and position, are refused as unknown fields.

name
string
required

Display name.

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

Lowercase letters and digits separated by single hyphens, not reserved and not used by another site in the company. Omit it to have one proposed from the name.

Required string length: 1 - 40
Pattern: ^[a-z0-9]+(-[a-z0-9]+)*$
visibility
enum<string>

Who may open the site once it is published. Defaults to private.

Available options:
private,
public
layout_name
string | null

The default layout for the site's pages. Null or omitted uses the site's own site layout.

Maximum string length: 255
settings
object

Design tokens such as colors and fonts.

Response

The new site.

One site.

status
integer
required

HTTP status code (mirrors the response status line).

data
object
required

One of the member's sites.

meta
object
required

Envelope metadata present on every response.