TwentyDEV icon

TwentyDEV

Consume the Twenty API

Actions252

Overview

The "Update One Note" operation allows users to modify an existing note by specifying its unique identifier. This node is useful in scenarios where notes need to be programmatically updated with new content, reordered, or have metadata changed. For example, it can be used to update the title and body of a note after receiving new information, or to adjust the position of a note within a list.

Properties

Name Meaning
Id The unique identifier of the note to update. This is required to specify which note record will be modified.
Depth Determines how much related nested data to include in the response:
- 0: Only the primary note's information.
- 1: The note plus its directly related objects.
- 2: The note, its related objects, and their related objects.
Position Numeric value indicating the note's position or order among other notes.
Title The new title text for the note.
Body The new body content of the note as a plain string.
Body V 2 The new body content of the note in JSON format, allowing structured content updates.
Created By JSON object representing the creator of the note record. This can be used to update or set the creator metadata.

Output

The node outputs a JSON object representing the updated note record. The structure includes the note's fields such as id, title, body, position, createdBy, and any related nested objects depending on the depth parameter. If binary data were involved (not indicated here), it would typically represent attachments or media associated with the note, but this node focuses on JSON data only.

Dependencies

  • Requires an API key credential to authenticate requests to the external service managing notes.
  • The node uses HTTP requests with JSON payloads to communicate with the backend API.
  • Proper configuration of the API base URL and authentication credentials in n8n is necessary.

Troubleshooting

  • Missing or invalid Id: The node requires a valid note ID to update. Ensure the ID is correctly provided; otherwise, the API will return an error indicating the note was not found.
  • Invalid JSON in Body V 2 or Created By: When providing JSON input for these fields, ensure the JSON is well-formed. Malformed JSON will cause parsing errors.
  • Permission errors: If the API key lacks permissions to update notes, the request will fail. Verify that the API key has sufficient rights.
  • Depth parameter misuse: Setting an unsupported depth level may result in incomplete or unexpected data in the response.
  • Network or API errors: Check connectivity and API status if requests fail unexpectedly.

Links and References

  • Refer to the external API documentation for detailed information about note fields and supported operations.
  • JSON formatting guides for preparing complex body content.
  • n8n documentation on configuring API credentials and HTTP request nodes.

Discussion