TwentyDEV icon

TwentyDEV

Consume the Twenty API

Actions252

Overview

This node operation allows creating multiple message participants in bulk within a messaging context. It is useful when you need to add several participants to a message thread or conversation simultaneously, such as when initializing group chats or adding users to an existing discussion.

Practical examples include:

  • Adding a list of users to a new group message.
  • Bulk inviting participants to a conversation.
  • Automating participant management in messaging workflows.

Properties

Name Meaning
Depth Determines how much related nested data is included in the response:
- 0: Only the primary message participant objects.
- 1: Primary objects plus their directly related objects.
- 2: Includes related objects of those related objects as well.
Body JSON object representing the message participants to create. This should contain the details of each participant, for example specifying roles like "role": "from". The body must be valid JSON and defines the participants' data.

Output

The output json field contains the created message participant objects. Depending on the Depth property, this can include just the primary participant data or also nested related objects up to two levels deep.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential to authenticate with the external Twenty API service.
  • The node uses the Twenty API base URL configured via credentials.
  • The request content type is JSON, and responses are expected in JSON format.

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 credential is correctly set up.
  • Depth Value Issues: Providing an unsupported depth value (other than 0, 1, or 2) may result in unexpected responses or errors.
  • API Limits or Permissions: Creating many participants at once might hit API rate limits or permission restrictions; check API documentation and credentials permissions.

Links and References

  • Twenty API Documentation (general reference for the API endpoints and data structures)
  • JSON formatting tools for validating the Body input before use.

Discussion