Brault Developers

Append blocks to a page

Regionalus.api.brault.appfollows the region selector in the top bar
POST
/v1/pages/{pageId}/blocks

Appends at the end of the live document, through the collaboration server, so open editors receive it immediately. Not naturally idempotent — send an Idempotency-Key. Answers 503 if the server has not persisted within 5 seconds; re-read the page before retrying. A page whose collaborative document was never initialized (seeded, or created outside this API, and never opened in the editor) answers 409 page_not_initialized: open it once in the editor, then retry.

AuthorizationBearer <token>

API key from Settings → Developers

In: header

Path Parameters

pageId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/v1/pages/string/blocks" \  -H "Content-Type: application/json" \  -d '{    "blocks": [      {        "type": "paragraph"      }    ]  }'
{  "object": "page",  "id": "string",  "name": "string",  "library_id": "string",  "folder_id": "string",  "published": true,  "published_at": "2019-08-24T14:15:22Z",  "published_by_id": "string",  "public_url": "string",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "created_by_id": "string",  "trashed_at": "2019-08-24T14:15:22Z",  "content": {    "format": "json",    "json": {},    "markdown": "string"  }}