Skip to main content
POST
Branch 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.

Path Parameters

site_id
string<uuid>
required

Public id of one of the member's sites.

Body

application/json

Optional choices for a branch. Any other field is refused as an unknown field.

slug
string

Lowercase letters and digits separated by single hyphens. Omit it to name the branch staging.

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

Response

The new branch, published and private.

One branch.

status
integer
required

HTTP status code (mirrors the response status line).

data
object
required

The branch of a site: a second site, cloned from the published content of its parent and published at once, so it renders what the parent renders. It is private, owned as the parent is, and has no shares. Only its owner and company admins can open it, in the frame at frame_path. Edit and publish it through the files, pages and publish operations, with site_id as the site id; the parent never changes. A branch is left out of the site list and the account menu.

meta
object
required

Envelope metadata present on every response.