Mutate document blocks
Apply ordered block operations (update, insertBefore, insertAfter, append, prepend, remove, moveBefore, moveAfter, replaceAll) to a Work document. Requires draft: true and ifUpdatedAt in the request body. Rate limit: 20 requests per minute per API key.
Authorization
apiKey Authorization<token>
Use format: users API-Key YOUR_API_KEY
In: header
Path Parameters
version*"2026-02"
API version
Default
"2026-02"Value in
- "2026-02"
tenant*string
Tenant slug
id*string
Work ID
Query Parameters
locale?string
Locale to mutate. Operates strictly on this locale with no fallback, so other locales are untouched.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/2026-02/string/works/string/blocks" \ -H "Content-Type: application/json" \ -d '{ "draft": true, "ifUpdatedAt": "2019-08-24T14:15:22Z", "operations": [ {} ] }'{ "versionTarget": "draft", "operations": [ {} ], "document": {}}