Overview
The node integrates with the Readwise Reader API to update existing documents in a user's Readwise Reader library. It allows users to modify various metadata fields of a document such as author, category, cover image URL, location status, published date, summary, and title by specifying the unique Document ID.
This node is beneficial when you want to programmatically keep your document metadata up-to-date or correct information after initial import or parsing. For example, you could automate updating the published date or category of articles you save, or change the location status of documents based on your workflow.
Properties
| Name | Meaning |
|---|---|
| Document ID | The unique identifier of the document you want to update. This is required to specify which document to modify. |
| Update Fields | A collection of optional fields to update on the document: |
| - Author | The document's author name. Overwrites the original author if present. |
| - Category | The document's category. Options include: Article, Email, EPUB, Highlight, Note, PDF, RSS, Tweet, Video. |
| - Image URL | URL of an image to use as the document's cover image. |
| - Location | The current location/status of the document. Options: Archive, Feed, Later, New. If an unavailable location is chosen, defaults apply. |
| - Published Date | The ISO 8601 datetime string representing when the document was published (e.g., "2020-07-14T20:11:24+00:00"). |
| - Summary | A text summary of the document. |
| - Title | The document's title, overwriting the original title. |
Output
The node outputs JSON data representing the updated document object returned from the Readwise Reader API. This typically includes all the document's metadata fields reflecting the changes made. There is no binary output.
Dependencies
- Requires an API key credential for authenticating with the Readwise Reader API.
- The base URL for API requests is
https://readwise.io/api/v3. - Proper configuration of the API key credential in n8n is necessary for successful operation.
Troubleshooting
- Invalid Document ID: If the provided Document ID does not exist or is incorrect, the API will likely return an error indicating the document was not found. Verify the ID before running.
- Unauthorized / Authentication Errors: Ensure the API key credential is valid and has proper permissions.
- Invalid Field Values: Providing unsupported values for fields like category or location may cause errors or fallback to default values. Use only the allowed options.
- Date Format Issues: The published date must be in ISO 8601 format; otherwise, the API may reject it.
- Empty Update Fields: If no update fields are specified, the request might do nothing or cause an error. Always provide at least one field to update.
Links and References
- Readwise Reader API Documentation (for detailed API usage and field definitions)
- ISO 8601 Date Format (for formatting published_date)