Skip to main content
PUT
Save a page whole

Authorizations

Authorization
string
header
required

An API key: ab_...

Path Parameters

slug
string
required

Brand slug

page
string
required

The page's slug, e.g. logo

Body

application/json
title
string
required
Required string length: 1 - 120
sections
object[]
required

The whole page, top to bottom

Maximum array length: 60
hidden
boolean

Kept, but not published

position
integer

Where among the brand's pages, from 0; the end for a new page

Required range: 0 <= x <= 9007199254740991
parent
string | null

Its parent page; null for the top. Three levels at most

Maximum string length: 60
Pattern: ^[a-z0-9]+(-[a-z0-9]+)*$
eyebrow
string | null
Maximum string length: 120
lede
string | null
Maximum string length: 1000
cover
string<uuid> | null

Its header and card image

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
icon
enum<string> | null
Available options:
folder,
photo,
palette,
brush,
camera,
movie,
music,
star,
heart,
flag,
bookmark,
briefcase,
building-store,
speakerphone,
rocket,
sparkles,
leaf,
world,
users,
archive
audience
enum<string>

On portals: who may read it

Available options:
everyone,
partners,
members
tabs
boolean

Its child pages as tabs across its top

layout
enum<string>

landing: no nav column, on-this-page or pager, for a home or campaign page; book when left out

Available options:
book,
landing
translations
object | null

Its words by language tag

Response

Replaced

data
object
required