TwentyDEV icon

TwentyDEV

Consume the Twenty API
Join our community

Actions252

Overview

This node operation updates a single message participant in a messaging system. It allows modifying details such as the participant's display name, role (e.g., sender or recipient), and associated identifiers like workspace member ID or person ID. This is useful in scenarios where you need to correct or change participant information after a message has been created, for example updating the display name or changing the participant’s role from "To" to "Cc".

Practical examples:

  • Correcting a typo in a participant’s display name.
  • Changing the role of a participant from "To" to "Cc" to reflect actual message recipients.
  • Associating a participant with a different workspace member or person ID.

Properties

Name Meaning
Id The unique identifier of the message participant object to update.
Depth Determines how much related nested data to include in the response: 0 = only primary object, 1 = primary plus directly related objects, 2 = primary plus related objects and their related objects.
Display Name The display name of the message participant, e.g., the name shown in the message UI.
Handle The handle or username of the participant.
Role The participant’s role in the message. Options are: From (sender), To (primary recipient), Cc (carbon copy recipient), Bcc (blind carbon copy recipient).
Workspace Member Id Identifier linking the participant to a specific workspace member.
Person Id Identifier linking the participant to a specific person entity.
Message Id Identifier of the message to which this participant belongs.

Output

The output JSON contains the updated message participant object. Depending on the depth parameter, it may include nested related objects up to two levels deep. The structure typically includes fields reflecting the updated properties such as displayName, handle, role, and linked IDs (workspaceMemberId, personId, messageId). No binary data output is indicated.

Dependencies

  • Requires an API key credential to authenticate requests to the external Twenty API service.
  • The node uses the base URL configured via credentials.
  • The operation sends HTTP requests with JSON bodies and expects JSON responses.

Troubleshooting

  • Missing or invalid Id: If the id property is not provided or incorrect, the update will fail because the target participant cannot be identified.
  • Invalid role value: Providing a role outside the allowed options ("from", "to", "cc", "bcc") will cause errors.
  • API authentication errors: Ensure that the API key credential is correctly set up and has permissions to update message participants.
  • Depth parameter misuse: Setting an unsupported depth value might result in unexpected response structures or errors.
  • Network or API errors: Check connectivity and API status if requests fail.

Links and References

Discussion