TwentyDEV icon

TwentyDEV

Consume the Twenty API
Join our community

Actions252

Overview

This node operation updates a single workspace member's details within a workspace management system. It allows modifying various attributes related to the workspace member such as their user email, display preferences (time format, date format, time zone), personal information (name, avatar URL), and workspace-specific settings like position and color scheme.

Typical use cases include:

  • Updating a team member’s profile information after a role change.
  • Adjusting user preferences for date/time formats or locale settings.
  • Changing the member’s position or visual appearance in the workspace interface.

For example, if a workspace admin wants to update a member’s preferred time zone and display name, this node operation can be used to send those changes to the backend API.

Properties

Name Meaning
Id The unique identifier of the workspace member object to update.
Depth Level of nested related objects to include in the response: 0 (primary only), 1 (direct relations), 2 (relations of relations).
User Email The email address associated with the user.
Time Format Preferred time format of the user. Options: SYSTEM, HOUR 24, HOUR 12.
Date Format Preferred date format of the user. Options: SYSTEM, MONTH FIRST, DAY FIRST, YEAR FIRST.
Time Zone The user's time zone string.
User Id The associated user ID for the workspace member.
Position Numeric position of the workspace member, possibly indicating order or rank.
Name JSON object representing the workspace member's name details.
Color Scheme Preferred color scheme for the user interface.
Locale Preferred language/locale setting for the user.
Avatar Url URL pointing to the workspace member's avatar image.

Output

The output JSON contains the updated workspace member object reflecting all changes made by the operation. The structure includes the primary member fields and, depending on the Depth parameter, may also include nested related objects up to two levels deep.

If binary data were involved (e.g., avatar images uploaded directly), it would be summarized here, but in this case, avatar is referenced by URL only.

Dependencies

  • Requires an API key credential to authenticate requests to the Twenty API service.
  • The base URL for API requests is configured via credentials.
  • The node uses standard HTTP headers for JSON content negotiation.

Troubleshooting

  • Missing or invalid Id: The operation requires a valid workspace member ID; ensure this is provided and correct.
  • Invalid property values: For options like Time Format or Date Format, only allowed values should be used; otherwise, the API may reject the request.
  • Authentication errors: Ensure that the API key credential is correctly set up and has permissions to update workspace members.
  • Network issues: Verify connectivity to the API endpoint and that the base URL is correctly configured.
  • JSON parsing errors: The Name property expects a JSON string; malformed JSON will cause failures.

Links and References

Discussion