ClickHelp User Manual

[API] Update TOC Node

Updates TOC node metadata.

PATCH projects/{project-id}/toc/nodes/{toc-node-id}

Authentication

This request requires basic authentication.

Request Parameters

Path params

project-id	string	The ID of the project to update the specified TOC node in.
toc-node-id	string	The ID of the TOC node to update.

Body params

caption	string	The TOC node caption.
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 node on the root level.
updatedFields	string	A comma-separated list of fields that will be updated. If a field name is not in the list, it will not be updated even if the field value is specified in other request parameters.

Samples

Request sample

Copy Code

Bash (Unix Shell)

curl --location -g --request PATCH 'https://{portal-url}/api/v1/projects/project-deep-space-exploration/toc/nodes/0e7adad0-2572-4966-8f02-bc46930cf848' ^
--data-raw '{
    "caption":"",
    "isShowInToc":true,
    "ordinalNo":2,
    "parentId":null,
    "topicId":"22671c49-4a7a-4eec-94f1-aafb47d1f856",
    "updatedFields":"parentId, caption, ordinalNo, isShowInToc"
}'

[API] Create TOC Node (Folder) [API] Delete TOC Node