Skip to content

Apply a batch of page item operations

POST
/pages/{page_id}/batch

Executes a batch of operations against a page's editable items. Requires the current ETag in the If-Match header.

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

Header Parameters

If-Match*

Strong ETag of the page being mutated. Required for optimistic concurrency control.

Typestring
Required

Path Parameters

page_id*

Page identifier or fullpath

Typestring
Required

Query Parameters

atomic

When true, all operations succeed or none are applied.

Typeboolean

Request Body

application/json
JSON
{
"operations": [
{
"additionalProperties": "string"
}
]
}

Responses

If-Match header missing

application/json
JSON
{
"message": "string",
"errors": {
"additionalProperties": [
]
}
}

Playground

Authorization
Headers
Variables
Key
Value
Body

Samples

Part of Nimbu, built by Zenjoy.