TwentyDEV icon

TwentyDEV

Consume the Twenty API
Join our community

Actions252

Overview

This node updates a single person record in the "People" resource of the connected service. It allows you to modify various attributes of a contact, such as their name, company association, position, contact details, and social media links. This operation is useful for keeping your contact database up-to-date with the latest information.

Practical examples:

  • Updating a person's job title after a promotion.
  • Changing the avatar URL when a new profile picture is available.
  • Adding or modifying phone numbers or email addresses.
  • Linking updated social media accounts like Twitter (X) or LinkedIn.

Properties

Name Meaning
Id The unique identifier of the person 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), or 2 (primary, directly related, and their related objects).
Name JSON object representing the contact’s name details.
Company Id Identifier of the company associated with the person.
Created By JSON object describing the creator of the record.
Position Numeric value indicating the person's position record order.
Avatar Url URL string pointing to the contact’s avatar image.
City The city where the contact is located.
Phones JSON object containing the contact’s phone numbers, including additional phones.
Job Title The contact’s job title as a string.
X Link JSON object representing the contact’s Twitter (X) account details.
Linkedin Link JSON object representing the contact’s LinkedIn account details.
Emails JSON object containing the contact’s email addresses, including additional emails.

Output

The node outputs a JSON object representing the updated person record. The structure includes all fields of the person, potentially enriched with nested related objects depending on the Depth parameter. This output reflects the current state of the person after the update operation.

No binary data output is involved.

Dependencies

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

Troubleshooting

  • Invalid Id error: If the provided Id does not correspond to any existing person, the API will likely return an error. Verify that the Id is correct.
  • Malformed JSON input: Properties like Name, Phones, Emails, Created By, X Link, and Linkedin Link expect valid JSON strings. Invalid JSON will cause parsing errors.
  • Permission issues: Ensure the API key has sufficient permissions to update person records.
  • Network or authentication failures: Check API credentials and network connectivity if requests fail.

Links and References

Discussion