Writing content

01 Versioned content and the live revision Most content does not change when you edit it: the edit becomes a new revision beside the old ones, and only the one marked live is what visitors see. Which records work this way, the three separate things that decide what is on the site, and how to read them.

02 patchRevision, revisions, or a revision by id Three request shapes write the content of a versioned record, and they differ in what they keep. patchRevision copies a revision and changes only what you send; revisions without an id replaces everything; revisions with an id rewrites a revision in place. Which to use, with the two keys that make a patch safe.

03 Making a revision live, rolling back and publishing Choosing which revision is live, going back to an older one, and deciding when visitors see the record at all. The request for each, the routes the types with their own rules use, and how to pin a patch so it does not undo a rollback.

04 Writing areas A layout area takes a value in the shape its input type expects, and that shape is often not the one a read gives back. The write shape for each input type, the ones that fail loudly and the ones that do not, and why a record read with areasContent cannot be sent back as it is.

05 Editing component collections A component collection is a list of components in one layout area: the sections of a page, the blocks of a guide page. Which key changes it, how positions count, why a position can point at the wrong element after a removal, and how to place a global component.

06 Custom fields Custom fields are the extra fields an administrator adds to menus, products, users and a dozen other record types. How to find a record's fields, read them by name, write one without touching the others, and why the answer to a write can look as if fields were lost.

07 Custom URLs and slugs A record's address comes from its slug, or from a custom URL that replaces it. How slugs are made and checked, how to set and clear a custom URL, and three things to get right: clearing a custom URL, setting one only after the record is created, and starting it with a slash.

08 Retries and writes that may have applied A write that timed out may have happened. Which requests are safe to send again, what a repeat of the others does, measured on this site, and how to make a create, a collection edit and a cart change safe to retry.

Objects ReferenceGenerated from the platform, so it is always current

API ReferenceEvery REST endpoint, in cURL, PHP, Python and JavaScript

In this unit