TwentyDEV icon

TwentyDEV

Consume the Twenty API
Join our community

Actions252

Overview

This node operation allows you to create a new workspace member within a specified workspace. It is useful for automating the process of adding users to a workspace, setting their preferences such as time and date formats, locale, avatar, and position within the workspace. Typical use cases include onboarding new team members, synchronizing user data from other systems, or managing workspace memberships programmatically.

Properties

Name Meaning
Depth Determines how much nested related object information to include in the response: 0 (only primary object), 1 (primary + directly related objects), or 2 (primary + directly related + related objects of those).
User Email The email address of the user to be associated with the workspace member.
Time Format Preferred time format for the user. Options: SYSTEM, HOUR 24, HOUR 12.
Date Format Preferred date format for the user. Options: SYSTEM, MONTH FIRST, DAY FIRST, YEAR FIRST.
Time Zone The user's time zone as a string.
User Id Required. The unique identifier of the user to associate with the workspace member.
Position Numeric value indicating the workspace member's position or rank within the workspace.
Name JSON object representing the workspace member's name details.
Color Scheme Preferred color scheme for the user interface.
Locale Preferred language/locale for the user.
Avatar Url URL pointing to the workspace member's avatar image.

Output

The node outputs a JSON object representing the newly created workspace member. This includes all the properties sent during creation along with any additional metadata returned by the API, potentially including nested related objects depending on the Depth parameter. The output does not include binary data.

Dependencies

  • Requires an API key credential to authenticate requests to the Twenty API.
  • The base URL for the API is configured via credentials.
  • The node uses the Twenty API version 1.0.3 OpenAPI specification for request construction.

Troubleshooting

  • Missing Required Fields: Ensure that the required User Id property is provided; otherwise, the API will reject the request.
  • Invalid Formats: Providing invalid values for Time Format, Date Format, or Depth may cause errors. Use only the allowed options.
  • Authentication Errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • Network Issues: Check connectivity to the API endpoint and ensure no firewall or proxy blocks the requests.
  • JSON Parsing Errors: The Name property expects a valid JSON string; malformed JSON will cause failures.

Links and References

Discussion