TwentyDEV icon

TwentyDEV

Consume the Twenty API
Join our community

Actions252

Overview

This node operation allows users to create multiple message folders in bulk within a messaging system. It is useful when organizing messages into different folders programmatically, for example, setting up predefined folder structures for new users or migrating existing folder setups from another system.

Practical examples include:

  • Automatically creating standard folders like "Inbox," "Sent," and "Archive" for each user.
  • Bulk importing folder structures during data migration.
  • Setting up project-specific folders for categorizing messages related to different projects.

Properties

Name Meaning
Depth Determines how much related nested information is included in the response:
- 0: Only the primary message folder object.
- 1: The primary folder plus its directly related objects.
- 2: The primary folder, its related objects, and their related objects.
Body JSON object defining the message folder(s) to create. Typically includes at least a name property specifying the folder's name. Example: { "name": "Message Folder name" }.

Output

The output contains JSON data representing the created message folder objects. Depending on the selected depth, this JSON may include nested related objects up to two levels deep. This allows users to receive detailed information about the newly created folders and their relationships immediately after creation.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the external messaging service.
  • The node uses a base URL configured via credentials to connect to the messaging API.
  • The request expects JSON content type and returns JSON responses.

Troubleshooting

  • Invalid JSON in Body: If the JSON provided in the Body property is malformed, the node will fail. Ensure the JSON syntax is correct.
  • Authentication Errors: Missing or invalid API credentials will cause authentication failures. Verify that the API key or token is correctly set up in the node credentials.
  • Permission Issues: The authenticated user must have permission to create message folders; otherwise, the API will reject the request.
  • Depth Parameter Misuse: Using unsupported depth values may result in unexpected responses or errors. Use only 0, 1, or 2 as specified.
  • API Rate Limits: Creating many folders at once might hit rate limits imposed by the API. Consider batching requests if necessary.

Links and References

  • Refer to the messaging service API documentation for details on the message folder resource and supported operations.
  • JSON formatting guides can help ensure the Body property is correctly structured.

Discussion