TwentyDEV icon

TwentyDEV

Consume the Twenty API

Actions252

Overview

This node operation allows users to create multiple favorite folders in bulk within the "Favorite Folders" resource. It is useful when you want to organize or categorize a large number of favorites at once, rather than creating each folder individually. For example, if you are managing bookmarks or saved items and want to quickly set up several categorized folders, this operation streamlines that process.

Properties

Name Meaning
Depth Determines how much related nested information is included in the response:
- 0: Only the primary favorite folder data.
- 1: Primary folder plus its directly related objects.
- 2: Includes related objects of those related objects as well.
Body JSON object representing the favorite folder(s) to create. Typically includes properties like the folder's name. This field accepts raw JSON input describing one or many favorite folders to be created.

Output

The output json field contains the details of the newly created favorite folders. The structure reflects the requested depth level:

  • At depth 0, only the basic information about each created favorite folder is returned.
  • At higher depths (1 or 2), the response includes nested related objects associated with each folder, such as linked favorites or metadata.

If binary data were involved (not indicated here), it would typically represent attachments or files related to the folders, but this node focuses on JSON data.

Dependencies

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

Troubleshooting

  • Invalid JSON in Body: If the JSON provided in the "Body" property is malformed, the node will fail to parse it. Ensure the JSON syntax is correct before execution.
  • Authentication Errors: Missing or incorrect API credentials will cause authorization failures. Verify that the API key or token is correctly configured in the node credentials.
  • Depth Parameter Misuse: Providing unsupported values outside 0, 1, or 2 for the "Depth" property may result in unexpected responses or errors. Use only the allowed options.
  • API Rate Limits: Creating many folders at once might hit rate limits imposed by the external API. If errors occur, consider batching requests or checking API usage policies.

Links and References

Discussion