TwentyDEV icon

TwentyDEV

Consume the Twenty API
Join our community

Actions252

Overview

This node operation allows you to create a single message participant within a messaging or communication system. A message participant represents an individual involved in a message thread, such as the sender ("From"), recipient ("To"), or carbon-copied recipients ("Cc" and "Bcc"). This operation is useful when you want to programmatically add participants to messages, for example, when automating email workflows, chat applications, or collaborative platforms.

Practical examples include:

  • Adding a new recipient to an existing message.
  • Specifying the role of a participant (e.g., marking someone as a CC).
  • Associating participants with workspace members or persons by their IDs.

Properties

Name Meaning
Depth Determines how much related nested data to include in the response:
- 0: Only the primary message participant object.
- 1: The primary object plus its directly related objects.
- 2: Includes related objects of those related objects as well.
Display Name The display name of the message participant.
Handle The handle (username or identifier) of the message participant.
Role The role of the participant in the message. Options are:
- From
- To
- Cc
- Bcc
Workspace Member Id The ID of the workspace member associated with this participant.
Person Id The ID of the person associated with this participant.
Message Id The ID of the message to which this participant belongs.

Output

The output JSON contains the created message participant object. Depending on the Depth property, it may include nested related objects up to two levels deep. The structure typically includes fields like participant identifiers, roles, display names, handles, and associations to workspace members or persons.

If binary data were supported, it would represent attachments or media related to the participant, but this operation does not output binary data.

Dependencies

  • Requires an API key credential to authenticate requests to the Twenty API service.
  • The node uses the Twenty API base URL configured via credentials.
  • No additional external dependencies are required beyond the API access.

Troubleshooting

  • Common issues:

    • Missing or invalid API authentication token can cause authorization errors.
    • Providing invalid or non-existent Message Id, Person Id, or Workspace Member Id may result in not found or validation errors.
    • Incorrect Role values outside the allowed options will be rejected.

  • Error messages:

    • 401 Unauthorized: Check that your API key credential is correctly set and has proper permissions.
    • 404 Not Found: Verify that the referenced message, person, or workspace member IDs exist.
    • 400 Bad Request: Ensure all required properties are provided and valid, especially role.

Links and References

Discussion