Update the default site revision

put

https://example.com/publishing/v1/site-revisions/default

Use the /site-revisions/default endpoint to update the values of properties 'autoPublishEnabled', 'name' and 'description' by replacing them with the ones in request body. Please note: Modifications to the 'autoPublishEnabled' flag are not picked up by WCH immediately but with a time lag of up to 30 seconds
User roles: admin, manager

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Only properties autoPublishEnabled, name and description will be updated, others will be ignored

name

object

required

an object holding the localized title for multiple languages

description

object

an object holding the localized description for multiple languages

links

object

string

required

length ≤ 64

Unique identifier representing a specific item

rev

string

required

length ≤ 64

a string identifying a specific version of the document

created

date-time

date when this item was created

creator

object

A reference to the User who has created the item

lastModified

date-time

date when this item was modifed for the last time

lastModifier

object

A reference to the User who has modified the item

state

string

enum

State of the site revision

Allowed:

autoPublishEnabled

boolean

If true, any updates affecting this site revision will be published automatically. Default is true.

lastSucceeded

date-time

date when this site revision was last updated successfully (last time a job for that site revision completed successfully)

active

boolean

indicates if this site revision is the active one.

job

object

Reference to the job that modified this site revision most recently

Responses

200Successfully updated the site revision.

400Unable to handle the request as it does not match the API definition.

409Response indicating that the site revision cannot be activated

429Too Many Requests, the server has reached a limit, the request must be sent again at a later time.