TwentyDEV icon

TwentyDEV

Consume the Twenty API
Join our community

Actions252

Overview

This node interacts with the Twenty API to update a single Blocklist object. It allows users to modify properties of an existing blocklist by specifying its unique identifier and providing new values for fields such as handle and workspace member ID. The node supports controlling the depth of related nested objects returned in the response, which can be useful when you want detailed information about related entities or just the primary blocklist data.

Common scenarios include:

  • Updating metadata or identifiers of a blocklist used for filtering or access control.
  • Changing ownership or association of a blocklist by updating the workspace member ID.
  • Fetching updated blocklist details along with related objects for further processing or auditing.

Example: A user wants to rename a blocklist handle and associate it with a different workspace member, then retrieve the updated blocklist including its directly related objects.

Properties

Name Meaning
Id The unique identifier of the blocklist object to update. This is required to specify which blocklist will be modified.
Depth Determines how much related nested data to include in the response:
- 0: Only the primary blocklist object.
- 1: Primary object plus directly related objects.
- 2: Primary, direct, and second-level related objects.
Handle The new handle (identifier or name) to assign to the blocklist.
Workspace Member Id The ID of the workspace member to associate with the blocklist. This can be used to change ownership or membership relations.

Output

The node outputs JSON data representing the updated blocklist object. The structure includes the primary blocklist fields and, depending on the Depth property, may also include nested related objects up to two levels deep. This output can be used downstream in workflows for logging, conditional logic, or further API calls.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the Twenty API.
  • The node expects the base URL and authentication headers to be configured via credentials.
  • No additional external dependencies are needed beyond the Twenty API service.

Troubleshooting

  • Missing or invalid Id: If the blocklist ID is not provided or incorrect, the API will fail to locate the blocklist to update. Ensure the correct ID is supplied.
  • Authentication errors: Invalid or missing API credentials will cause authorization failures. Verify that the API key credential is correctly set up.
  • Invalid property values: Providing malformed or unsupported values for handle or workspaceMemberId may result in validation errors from the API.
  • Depth parameter misuse: Setting an unsupported depth value outside 0, 1, or 2 might cause unexpected responses or errors.
  • Network issues: Connectivity problems with the Twenty API endpoint will prevent successful updates.

Links and References

Discussion