TwentyDEV icon

TwentyDEV

Consume the Twenty API
Join our community

Actions252

Overview

This node allows you to create a new blocklist in the TwentyDEV platform. Blocklists are typically used to manage lists of blocked or restricted items, such as users, IP addresses, or content, depending on the application context. Creating a blocklist can help automate moderation, security, or compliance workflows by programmatically defining what should be blocked.

Practical examples include:

  • Automatically adding spammy user handles to a blocklist.
  • Managing workspace-specific blocklists for collaborative environments.
  • Controlling access or visibility by maintaining nested related objects with different depth levels.

Properties

Name Meaning
Depth Determines how much related object data is included in the response when creating the blocklist. Options:
- 0: Only the primary blocklist object.
- 1: Primary object plus directly related objects.
- 2: Primary object, its related objects, and their related objects.
Handle The unique identifier or name for the blocklist being created.
Workspace Member Id Identifier for the workspace member associated with this blocklist. This links the blocklist to a specific user or member within a workspace.

Output

The output JSON contains the newly created blocklist object. Depending on the Depth property, this object may include nested related objects up to two levels deep. The structure will reflect the blocklist's details such as its handle, associated workspace member, and any related entities included per the depth setting.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the TwentyDEV API.
  • The node uses the base URL configured in the credentials to send requests.
  • The node expects the TwentyDEV API to be accessible and properly configured for the authenticated user.

Troubleshooting

  • Common issues:

    • Invalid or missing API authentication token can cause authorization errors.
    • Providing an invalid workspaceMemberId or handle might result in API validation errors.
    • Network connectivity problems can prevent successful API calls.

  • Error messages:

    • 401 Unauthorized: Check that the API key credential is correctly set and has necessary permissions.
    • 400 Bad Request: Verify that required properties like handle and workspaceMemberId are provided and valid.
    • 404 Not Found: The specified workspace member might not exist; confirm the ID is correct.

Resolving these usually involves verifying credentials, input values, and network status.

Links and References

Discussion