TwentyDEV icon

TwentyDEV

Consume the Twenty API
Join our community

Actions252

Overview

This node allows you to create a new person record in the "People" resource of the connected API. It is useful for automating the addition of contact information into your system, such as adding new leads, employees, or clients with detailed personal and professional data.

Typical use cases include:

  • Automatically adding new contacts collected from web forms or other sources.
  • Syncing people data from external CRMs or databases.
  • Enriching your contact list with social media and communication details.

For example, you can create a person with their name, job title, company association, contact details (emails, phones), and social media links like Twitter (X) and LinkedIn.

Properties

Name Meaning
Depth Determines how much nested related object data to include in the response: 0 = only primary person info; 1 = primary plus directly related objects; 2 = primary plus related objects and their related objects.
Name The contact’s full name, provided as a JSON object.
Company Id Identifier of the company associated with the person.
Created By Information about the creator of this person record, provided as a JSON object.
Position Numeric position or ranking of the person record.
Avatar Url URL to the contact’s avatar image.
City The city where the contact is located.
Phones Contact’s phone numbers, structured as a JSON object that may include multiple additional phone numbers.
Job Title The contact’s job title or role within their organization.
X Link Contact’s Twitter (X) account details, provided as a JSON object potentially containing multiple secondary links.
Linkedin Link Contact’s LinkedIn account details, provided as a JSON object potentially containing multiple secondary links.
Emails Contact’s email addresses, structured as a JSON object that may include multiple additional emails.

Output

The node outputs the created person record as JSON data. The output includes all the fields sent in the request along with any additional metadata or identifiers assigned by the API upon creation. The depth property controls how much related nested data is included in the response.

No binary data output is indicated.

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 standard HTTP headers for JSON content type and accepts JSON responses.

Troubleshooting

  • Invalid JSON input: Since several properties expect JSON strings (e.g., name, phones, emails), ensure these are valid JSON. Invalid JSON will cause parsing errors.
  • Missing required fields: If the API requires certain fields (like name or companyId), omitting them may result in errors.
  • Authentication errors: Ensure the API key credential is correctly set up and has permissions to create person records.
  • Depth parameter misuse: Setting an unsupported depth value might lead to unexpected responses or errors.
  • Network issues: Check connectivity and API endpoint availability if requests fail.

Links and References

Discussion