TwentyDEV icon

TwentyDEV

Consume the Twenty API
Join our community

Actions252

Overview

This node operation allows you to create a new favorite folder within the Twenty API environment. It is useful for organizing and managing collections of favorite items by grouping them into folders. Typical use cases include categorizing bookmarks, saved articles, or any other entities supported by the Twenty platform that users want to keep organized.

For example, a user might create a favorite folder named "Tech Articles" to group all their saved technology-related content, specifying the folder's position in a list and controlling how much related data is returned with the response.

Properties

Name Meaning
Depth Determines the level of nested related objects included in the response:
- 0: Only the primary object's information.
- 1: Primary object plus its directly related objects (no further nesting).
- 2: Primary object, its related objects, and those objects' related objects.
Position Numeric value indicating the position of the favorite folder in a list or order.
Name The name assigned to the favorite folder being created.

Output

The output JSON contains the details of the newly created favorite folder. Depending on the Depth property, this includes the folder's own properties and optionally nested related objects up to two levels deep. This enables clients to receive comprehensive information about the folder and its context in a single response.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the Twenty API.
  • The node expects the base URL and authentication token to be configured in the node credentials.
  • The node uses standard HTTP headers for JSON communication (Accept: application/json, Content-Type: application/json).

Troubleshooting

  • Common issues:

    • Missing or invalid API credentials will cause authentication failures.
    • Providing an invalid Position (e.g., negative numbers) may result in errors or unexpected ordering.
    • Omitting the Name or providing an empty string may cause the API to reject the request.

  • Error messages:

    • Authentication errors typically indicate missing or incorrect API keys; verify credentials configuration.
    • Validation errors from the API may mention required fields or invalid values; ensure all required properties are correctly set.
    • Network or timeout errors suggest connectivity issues; check network access and API availability.

Links and References

Discussion