Actions22
Overview
This node integrates with the BookStack platform to manage its resources programmatically. Specifically, for the Shelf - Update operation, it allows users to update an existing shelf's details such as its name, description, associated books, and tags.
Typical use cases include:
- Renaming a shelf or updating its description to reflect new content.
- Adding or removing books from a shelf by specifying their IDs.
- Updating tags to improve shelf categorization or searchability.
For example, a user might update a shelf named "Summer Reads" to add new book IDs or change its description to highlight featured titles.
Properties
| Name | Meaning |
|---|---|
| Shelf ID | The unique identifier of the shelf to update (required). Example: 789 |
| Name | New name for the shelf (up to 255 characters). |
| Description | New description for the shelf (up to 1900 characters). |
| Books | Comma-separated list of book IDs to associate with this shelf. Example: 123,456,789 |
| Tags | Comma-separated tags for the shelf to categorize or label it. Example: tag1, tag2, tag3 |
Output
The node outputs JSON data representing the updated shelf object returned from the BookStack API. This typically includes the shelf's updated properties such as its ID, name, description, list of books (by ID), and tags (as objects with names).
No binary data output is produced by this operation.
Dependencies
- Requires an active connection to a BookStack instance via an API key credential.
- The node uses HTTP requests to the BookStack REST API endpoints.
- Proper API permissions are needed to update shelves on the BookStack server.
Troubleshooting
- Missing or invalid Shelf ID: The operation requires a valid shelf ID. Ensure the ID exists in your BookStack instance.
- Invalid book IDs in the Books field: Book IDs must be numeric and correspond to existing books; otherwise, the API may reject the update.
- API authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
- Exceeded character limits: Name and description fields have maximum lengths (255 and 1900 characters respectively); exceeding these may cause errors.
- Network or connectivity issues: Ensure the BookStack server is reachable from n8n.
Common error messages will typically indicate missing parameters, invalid input formats, or authorization failures. Reviewing the error message and verifying inputs usually resolves these issues.