TwentyDEV icon

TwentyDEV

Consume the Twenty API

Actions252

Overview

This node allows creating multiple notes in bulk via the "Create Many Notes" operation under the "Notes" resource. It is useful when you need to add several notes at once, for example, importing a batch of comments or annotations into a system that supports note-taking or record-keeping.

Practical examples include:

  • Importing multiple customer feedback entries as notes.
  • Adding a series of log entries or audit trail notes programmatically.
  • Bulk creation of project or task notes from an external source.

Properties

Name Meaning
Depth Determines how much related nested information to include in the response:
- 0: Only the primary note object.
- 1: The note plus its directly related objects.
- 2: The note, its related objects, and their related objects.
Body A JSON object representing the note(s) to create. This should contain the data structure expected by the API for one or many notes.

Output

The output json field contains the response from the API after creating the notes. Depending on the Depth parameter, this will include the created note objects with varying levels of nested related data:

  • At depth 0, only the basic note information is returned.
  • At depth 1, the note plus its immediate related objects are included.
  • At depth 2, the note, its related objects, and those objects' related objects are included.

If the API supports binary data for notes (e.g., attachments), it would be included accordingly, but based on the provided code and properties, the main output is JSON data representing the created notes.

Dependencies

  • Requires an API key credential to authenticate requests to the Twenty API.
  • The base URL for the API is configured dynamically from credentials.
  • The node uses the Twenty API version 1.0.3 OpenAPI specification for request construction.

Troubleshooting

  • Invalid JSON in Body: Since the Body property expects valid JSON, malformed JSON input will cause errors. Ensure the JSON is correctly formatted.
  • Authentication Errors: Missing or invalid API credentials will result in authentication failures. Verify that the API key credential is properly set up.
  • Depth Parameter Misuse: Using unsupported depth values may cause unexpected responses or errors. Use only 0, 1, or 2 as specified.
  • API Limitations: Creating too many notes at once might hit API rate limits or payload size restrictions. Consider batching if errors occur.

Links and References

Discussion