Skip to content

Batch update page​

POST
/pages/{page_id}/batch

Executes multiple operations (set, insert, move, delete) on a page in a single request. Requires an ETag via the If-Match header for optimistic concurrency control. Operations are processed in order. Use atomic=true to roll back all changes if any operation fails.

Authorizations​

bearerToken|siteContext
bearerToken

Personal access token tied to a user account. Requires the X-Nimbu-Site header to scope requests.

TypeHTTP (bearer)
+
siteContext

Identifier of the site context when authenticating with a personal access token.

TypeAPI Key (header: X-Nimbu-Site)
or
siteToken

Site-scoped API token that already encodes the site context.

TypeHTTP (bearer)

Parameters​

Path Parameters

page_id*

Page identifier (ObjectId) or fullpath

Typestring
Required

Query Parameters

atomic

If true, rolls back all operations when any operation fails

Typeboolean
Defaultfalse
include

Set to 'result' to include the full updated page in the response

Typestring
Valid values
"result"

Request Body​

application/json
JSON
{
"operations": [
{
"op": "string",
"path": "string",
"value": "string",
"after": "string"
}
]
}

Responses​

batch operations completed

application/json
JSON
{
"results": [
{
"index": 0,
"status": "string",
"path": "string",
"id": "string",
"warning": "string",
"error": "string",
"message": "string"
}
],
"etag": "string",
"updated_at": "string",
"page": {
"id": "string",
"url": "string",
"created_at": "string",
"updated_at": "string",
"published": true,
"homepage": true,
"template": "string",
"channel": "string",
"filter": "string",
"depth": 0,
"security_mechanism": "string",
"locales": [
"string"
],
"fixed_locale": "string",
"position": 0,
"og_image": {
"filename": "string",
"url": "string",
"content_type": "string",
"permanent_url": "string",
"permanent_relative_url": "string",
"permanent_backend_url": "string",
"version": "string",
"checksum": "string",
"size": 0,
"width": 0,
"height": 0,
"additionalProperties": "string"
},
"parent": "string",
"parent_path": "string",
"public_url": "string",
"slug": "string",
"fullpath": "string",
"title": "string",
"seo_title": "string",
"seo_description": "string",
"seo_keywords": "string",
"items": {
"additionalProperties": {
}
},
"translations": {
"additionalProperties": {
}
},
"additionalProperties": "string"
}
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​