Twenty CRM icon

Twenty CRM

Interact with Twenty CRM - Open Source CRM

Opportunity → Upsert

AI-generated

Summary

Upsert an opportunity in Twenty CRM by matching an existing record on a specified field and value, updating it if found, or creating a new opportunity otherwise.

Inputs

  • Match Field (required) — Field to use for matching an existing opportunity (currently only 'Name' is supported).
  • Match Value (required) — Value to search for in the match field to locate an existing opportunity.
  • Name (required) — Name of the opportunity to create or update.
  • Additional Fields — Optional fields to specify additional opportunity details such as Amount, Close Date, Company ID, Point of Contact ID, and Stage.
  • Custom Fields — Custom fields as key-value pairs to include additional user-defined data in the opportunity.

Output shape

a single opportunity record object

Returns the created or updated opportunity record. Matching is performed using the specified field and value; if no existing opportunity is found, a new one is created. The API request transforms input fields appropriately, e.g., converting amount to currency micros and handling custom fields serialization.

Examples

Example 1: Upsert an opportunity named 'Big Deal' matching on name field with amount and stage specified.

Match Field: Name, Match Value: 'Big Deal', Name: 'Big Deal', Additional Fields: Amount=1000, Stage='NEW'

Links

Discussion