Skip to main content
POST
Creates a document.

Authorizations

X-API-Key
string
header
required

Your Gorelo API key. See Generate API key. If your data is hosted in Australia, click the base URL at the top of this page and select https://api.aue.gorelo.io.

Body

The document.

A new document.

Title
string | null

Title. Required, max 200 characters.

Body
string | null

The body, as HTML. Must not embed images as data: URLs - upload them first.

ParentDocumentId
string<uuid> | null

The document to nest this one under; omit or null for a top-level document.

ClientId
integer<int64> | null

The client the document belongs to; omit or null for an internal document. Under a parent the document takes the parent's client, and a different value here is rejected.

Response

OK

StatusCode
enum<integer>
Available options:
100,
101,
102,
103,
200,
201,
202,
203,
204,
205,
206,
207,
208,
226,
300,
301,
302,
303,
304,
305,
306,
307,
308,
400,
401,
402,
403,
404,
405,
406,
407,
408,
409,
410,
411,
412,
413,
414,
415,
416,
417,
421,
422,
423,
424,
426,
428,
429,
431,
451,
500,
501,
502,
503,
504,
505,
506,
507,
508,
510,
511
IsSuccess
boolean
Data
object

A single document, with its body, children, attachments and related items.

DataContext
object | null
Example:

null

Notifications
object[]