Skip to main content
Editors change a document’s draft, then publish it. Until they do, visitors and the API see the published copy as it was.

Published or draft

string
default:"published"
published answers what visitors see. draft answers the latest edits, published or not: it needs a credential that may see drafts, such as an API key with the type’s write scope (content:<type>:write). The public, and a key with only the read scope, get 403.

Locales

string
The locale to read or write (en, fr …). Left out, it is the site’s default locale.
A document’s locales are listed by its List locales route, under Publishing in the API reference.

Ids

A document’s id names its locale and mode.
The same document’s draft id is its published id with the last part changed. A create answers the id of the mode it was made in.