TwentyDEV icon

TwentyDEV

Consume the Twenty API

Actions252

Overview

This node operation updates a single "Note Target" object in the connected system via an API. It allows users to modify properties of a specific Note Target by its unique identifier. This is useful when you need to change associations or details related to a note target, such as linking it to a different person, company, opportunity, or note.

Practical examples include:

  • Updating which person or company a note target is associated with.
  • Changing the linked opportunity for a note target.
  • Adjusting the depth of returned nested related objects to control response detail.

Properties

Name Meaning
Id The unique identifier of the Note Target object to update.
Depth Level of nested related objects included in the response: 0 (only primary object), 1 (primary + direct relations), 2 (primary + direct + second-level relations).
Note Id Identifier of the note to associate with this Note Target.
Person Id Identifier of the person to associate with this Note Target.
Company Id Identifier of the company to associate with this Note Target.
Opportunity Id Identifier of the opportunity to associate with this Note Target.

Output

The output JSON contains the updated Note Target object. Depending on the Depth property, the response may include nested related objects up to two levels deep. The structure reflects the updated state of the Note Target after the operation.

No binary data output is expected from this node operation.

Dependencies

  • Requires an API key credential to authenticate requests to the external Twenty API service.
  • The base URL and authentication token must be configured in the node credentials.
  • The node uses HTTP requests with JSON payloads to interact with the API.

Troubleshooting

  • Missing or invalid Id: The operation requires a valid Note Target Id. Ensure the Id is provided and correct.
  • Authentication errors: Verify that the API key credential is correctly set up and has necessary permissions.
  • Invalid related object Ids: If updating associations (personId, companyId, etc.), ensure these IDs exist in the system.
  • Depth parameter misuse: Using a depth value outside 0-2 may cause unexpected responses or errors.
  • API connectivity issues: Check network access and API endpoint availability.

Common error messages typically relate to invalid input data, unauthorized access, or resource not found. Resolving them involves verifying inputs, credentials, and API status.

Links and References

Discussion