Skip to main content
PATCH
Edit page or site metadata

Authorizations

Authorization
string
header
required

Cactal API key. Create one in the dashboard or via POST /apiKeys. The plaintext key is shown once at creation.

Body

application/json
websiteId
string
required
Minimum string length: 1
metadata
any
required
leaseToken
string
required
Minimum string length: 1
page
string

Page to edit. Omit to edit the site-wide default metadata in website_config.

Required string length: 1 - 255

Response

The committed edit and the effective metadata.

version
integer
required

Head version after the edit: the previous head plus one, or the unchanged head when changed is false.

changed
boolean
required

false when the edit was a no-op and no new version was created.

metadata
any
required

Metadata now in the source: the page metadata when page was sent, otherwise the site-wide defaults that page metadata is layered onto.

metadataChanged
boolean
required

Whether the metadata differs from its previous value.