TwentyDEV icon

TwentyDEV

Consume the Twenty API

Actions252

Overview

This node operation creates a new "Note Target" in the connected system via the Twenty API. A Note Target typically links a note to one or more entities such as a person, company, or opportunity. This operation is useful when you want to programmatically associate notes with specific records for better organization and context within your workflows.

Practical examples:

  • Automatically attaching meeting notes to a contact (person) after a call.
  • Linking a note about a sales discussion to an opportunity record.
  • Associating internal comments or reminders with a company profile.

Properties

Name Meaning
Depth Determines how much related object data to include in the response. Options:
- 0: Only the primary Note Target object.
- 1: Primary object plus directly related objects.
- 2: Primary object, related objects, and their related objects.
Note Id The unique identifier of the note to be linked as a target.
Person Id The unique identifier of the person entity to link the note target to.
Company Id The unique identifier of the company entity to link the note target to.
Opportunity Id The unique identifier of the opportunity entity to link the note target to.

Output

The output JSON contains the newly created Note Target object. Depending on the Depth property, this object may include nested related objects up to two levels deep. The structure will reflect the associations between the note and the specified entities (person, company, opportunity).

If binary data were involved (not indicated here), it would represent file attachments or similar content linked to the note target, but this operation focuses on JSON data only.

Dependencies

  • Requires an API key credential for authenticating with the Twenty API.
  • The node expects the base URL and authentication details to be configured in the credentials.
  • No additional external dependencies are required beyond the Twenty API access.

Troubleshooting

  • Missing or invalid IDs: Ensure that the Note Id and at least one of Person Id, Company Id, or Opportunity Id are provided and valid. Missing these may cause the API to reject the request.
  • Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions to create note targets.
  • Depth parameter misuse: Setting an unsupported depth value might result in unexpected responses or errors; use only 0, 1, or 2.
  • API connectivity issues: Network problems or incorrect base URL configuration can cause failures; check credentials and network settings.

Links and References

Discussion