Skip to main content
Essal Office allows you to create and manage documents programmatically. This guide walks through creating a new document, setting its initial permissions, and attaching a file.

Creating a Document

Send a POST request to the documents endpoint with a title and optional initial content:
A successful response returns the full document object:

Setting Permissions

By default, a new document is private to the creator. Grant access to other users or groups:

Uploading Attachments

Attach files to a document by first uploading to the Office file store, then linking:
Documents support up to 50 attachments and a maximum single file size of 100 MB. For larger files, use the chunked upload endpoint at /v1/office/files/upload/chunked.

Publishing a Document

Move a document from draft to published status to make it available to permitted viewers:
The document status transitions to published and a office.document.published event fires on the event bus.