TwentyDEV icon

TwentyDEV

Consume the Twenty API
Join our community

Actions252

Overview

The node operation "Find Message Folder Duplicates" is designed to identify duplicate message folders based on specified criteria. It allows users to specify the depth of related objects to include in the response and provide data or IDs to search for duplicates. This operation is useful in scenarios where managing message folders efficiently is critical, such as cleaning up redundant folders in messaging systems or organizing folder structures by detecting duplicates.

Practical examples:

  • A user wants to find all message folders that have the same name or attributes to merge or delete duplicates.
  • An administrator needs to audit message folders and ensure no redundant folders exist within a system.

Properties

Name Meaning
Depth Determines the level of nested related objects to include in the response:
- 0: Returns only the primary object's information.
- 1: Returns the primary object along with its directly related objects.
- 2: Returns the primary object, its directly related objects, and their related objects.
Data JSON array specifying the criteria for finding duplicates. Typically includes fields like "name" to match message folder names. Example: [{"name": "Message Folder name"}].
Ids JSON array of IDs to limit the search for duplicates to specific message folders. Example: [null] by default, which means no specific IDs are targeted unless provided.

Output

The output contains a JSON structure representing the found duplicate message folders according to the specified criteria and depth. The JSON will include the primary message folder objects and, depending on the depth setting, their related objects up to two levels deep.

If binary data were involved (not indicated here), it would typically represent attachments or media associated with message folders, but this operation focuses on JSON data about folders.

Dependencies

  • Requires an API key credential to authenticate requests to the external Twenty API service.
  • The node uses the Twenty API base URL configured via credentials.
  • No additional environment variables are explicitly required beyond standard API authentication setup.

Troubleshooting

  • Common issues:

    • Invalid JSON format in the "Data" or "Ids" properties can cause request failures. Ensure valid JSON syntax.
    • Incorrect or missing API credentials will result in authentication errors.
    • Setting an unsupported depth value outside 0, 1, or 2 may lead to unexpected responses or errors.

  • Error messages:

    • Authentication errors indicate invalid or missing API keys; verify credentials configuration.
    • JSON parsing errors suggest malformed input in "Data" or "Ids"; validate JSON before execution.
    • API response errors might occur if the specified IDs do not exist or if the API rate limits are exceeded.

Links and References

Discussion