Actions71
- Asset Actions
- Attribute Actions
- Block Actions
- Database Actions
- Document Actions
- Markdown Table Actions
- Notebook Actions
- Search Actions
- System Actions
- Tag Actions
Notebook → Set Configuration
AI-generatedOverview
This node operation allows users to update the configuration settings of a specific notebook in SiYuan. It is useful for scenarios where users need to modify notebook properties such as its name, closed status, save paths, templates, sorting mode, or icon. For example, a user can rename a notebook, change its icon, or update the template paths programmatically within an automation workflow.
Use Case Examples
- Updating the name and icon of a notebook to reflect a new project phase.
- Changing the save path for daily notes to organize files better.
- Setting the notebook to closed status to prevent further edits.
Properties
| Name | Meaning |
|---|---|
| Notebook ID | The unique identifier of the notebook to update. |
| Configuration (JSON) | A JSON object containing the configuration fields to update, such as name, closed, refCreateSavePath, createDocNameTemplate, dailyNoteSavePath, dailyNoteTemplatePath, sortMode, and icon. |
Output
JSON
success- Indicates whether the configuration update operation was successful.
Dependencies
- Requires SiYuan API URL and API token credentials for authentication.
Troubleshooting
- Ensure that the SiYuan API URL and token credentials are correctly set; missing or invalid credentials will cause authentication errors.
- Verify that the provided Notebook ID exists and is accessible; an invalid ID will result in an error.
- The JSON configuration must be properly formatted and contain supported fields; invalid JSON or unsupported fields may cause the operation to fail.