Read the page builder
Requires builder:read or pages:read. Set include_tree=false to omit the section tree.
Required scope: any of builder:read, pages:read.
query Parameters
page_idPage id.
include_treeInclude the section tree. Defaults to true.
Read the page builder › Responses
The builder summary.
idPage id.
page_idPage id.
Builder summary, including the section tree when include_tree is true.
Read one builder node
Required scope: any of builder:read, pages:read.
query Parameters
page_idPage id.
node_idNode id from the builder tree.
Read one builder node › Responses
The node.
idNode id.
page_idPage id.
node_idNode id.
pathLocation of the node in the tree.
summaryShort node summary when the builder returns one.
The node object.
Update node fields
updates must include misc, style, or both. This patches those objects. It does not replace the whole node.
Required scope: any of builder:write, pages:write.
Update node fields › Request Body
page_idPage id.
node_idNode id.
Must include misc, style, or both.
node_typeOptional node type hint.
Update node fields › Responses
The update result.
idNode id.
page_idPage id.
node_idNode id.
updatedtrue when the node was saved.
pathNode path.
Replace a builder node
node is the complete node object that replaces the existing node.
Required scope: any of builder:write, pages:write.
Replace a builder node › Request Body
page_idPage id.
node_idNode id to replace.
Complete replacement node. A JSON string is also accepted.
Replace a builder node › Responses
The replace result.
idNode id.
page_idPage id.
node_idNode id.
updatedtrue when the node was replaced.
pathNode path.
builder_warningsJSON string of builder warnings.
Update the page reveal delay
Required scope: any of pages:write, builder:write.
Update the page reveal delay › Request Body
page_idPage id.
timeReveal delay in seconds.
sync_with_videoReveal in sync with a video.
scroll_into_viewScroll the delayed section into view.
video_node_idBuilder node id of the video to sync with.
Update the page reveal delay › Responses
The delay result.
idPage id.
page_idPage id.
updatedtrue when the delay was saved.
Saved delay settings.
Read editable content fields
fields and variables are JSON strings. Use the field keys with PATCH /pages/content.
Required scope: pages:read.
query Parameters
page_idPage id.
Read editable content fields › Responses
The content map.
idPage id.
page_idPage id.
page_namePage name.
field_countNumber of editable fields.
variable_countNumber of template variables.
variablesJSON string of variable names.
fieldsJSON string of editable fields.
ready_for_variable_replacementtrue when the page still has variables.