Twenty icon

Twenty

Interact with the Twenty API
Join our community

Actions25

Overview

This node interacts with the Twenty API to create multiple people records in batch mode. It is useful for scenarios where you need to import or synchronize large sets of people data into the Twenty workspace efficiently. For example, you can send a JSON array of people records to be created or updated in one batch request, controlling how existing records are handled and whether related records are included in the response.

Use Case Examples

  1. Importing a list of new employees into the Twenty workspace by sending their details as a JSON array.
  2. Updating existing people records or adding new ones in bulk using the upsert strategy to avoid duplicates.

Properties

Name Meaning
Base URL Base URL for your Twenty workspace REST API, including the /rest suffix.
Records (JSON) Raw JSON array containing the people records to send in the batch request. If left empty, the node uses incoming item data.
Depth Controls whether related records are expanded in the response. Options are 'Primary Record Only' or 'Include Direct Relations'.
Upsert Strategy Controls whether existing records are updated when matching criteria is met. Options are 'Create Only' (skip existing matches) or 'Create or Update' (upsert).
Request Options Additional request options including batching controls, SSL certificate validation, proxy settings, and request timeout.

Output

JSON

  • response - The API response containing the created or updated people records, optionally including related records based on the depth setting.

Dependencies

  • Requires an API key credential for authentication with the Twenty API.

Troubleshooting

  • Ensure the Base URL is correctly set to your Twenty workspace REST API endpoint including the /rest suffix.
  • If using the upsert strategy, verify that matching criteria are correctly defined to avoid unintended updates or skips.
  • Batching settings should be configured to avoid hitting rate limits or timeouts; adjust batch size and interval accordingly.
  • If SSL certificate validation fails, enabling 'Ignore SSL Issues' can bypass this but may expose security risks.
  • Proxy settings must be correctly formatted if used, including authentication if required.
  • Timeouts may occur if the server is slow or the batch size is too large; increase timeout or reduce batch size as needed.

Discussion