PublishStatus

string

Allowed values:publishedunpublished

DocumentTree

object

a document tree

idstring(uuid)required

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

parent_document_idstring(uuid)

Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2

titlestringrequired
slugstringrequired

document slug

Example:path-for-seo

metadataobjectrequired

metadata of the document

Example:{"author":"John Doe"}

statusstringrequired

Allowed values:publishedunpublished

childrenarray[object]required

a document tree

Example:{"id":"d32d905a-ed33-46a3-a093-d8f536af9a8a","title":"Hello world","status":"published","slug":"hello-world","metadata":{"author":"John Doe"},"children":[]}

Show Child Parameters
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example

ChildNode

object
One Of
typestringrequired

Allowed values:heading

levelnumber

Level of the heading which maps to HTML tag

>= 1<= 6

childrenOne Of
array[object]

List of children nodes of the current node

HeadingBlockobject
Show Child Parameters
Example

NodeChildren

array

List of children nodes of the current node

One Of
typestringrequired

Allowed values:heading

levelnumber

Level of the heading which maps to HTML tag

>= 1<= 6

childrenOne Of
array[object]

List of children nodes of the current node

HeadingBlockobject
Show Child Parameters

HeadingBlock

object
typestringrequired

Allowed values:heading

levelnumber

Level of the heading which maps to HTML tag

>= 1<= 6

childrenOne Of
array[object]

List of children nodes of the current node

Example