ClickHelp User Manual

[API] Create TOC Node (Folder)

Creates a folder in the table of contents of a project.

POST projects/{project-id}/toc/nodes

Authentication

This request requires basic authentication.

Request Parameters

Path params

project-id	string	The ID of the project to create the folder in.

Body params

caption	string	The folder name.
isShowInToc	bool	[optional] Whether to show the folder in the TOC in publications. Sets the corresponding option in the topic's properties. false by default.
ordinalNo	int	[optional] The position of the node in the TOC. Not sending the parameter will place the node at the end.
parentId	string	[optional] The unique identifier of the parent TOC node. Sending null or not sending the parameter will create a node on the root level.

Samples

Request sample

Copy Code

Bash (Unix Shell)

curl --location -g --request POST 'https://{portal-url}/api/v1/projects/project-deep-space-exploration/toc/nodes' ^
--data-raw '{
    "caption":"New folder",
    "isShowInToc": true,
    "ordinalNo": 0,
    "parentId": "0e7adad0-2572-4966-8f02-bc46930cf848"
}'

[API] Get Child TOC Nodes [API] Update TOC Node