Create Opportunity

POST 
/opportunities/

Create Opportunity

Request

Version stringrequired

API Version

Available optionsv3

application/json

application/json

Body

Bodyrequired

pipelineIdstringrequired

pipeline Id

locationIdstringrequired

Identifier of the location (sub-account)

namestringrequired

Name of the opportunity

pipelineStageIdstring

Identifier of the pipeline stage

statusstringrequired
Current status of the opportunity
Available optionsopenwonlostabandonedall
contactIdstringrequired

Identifier of the contact linked to the opportunity

monetaryValuenumber

Monetary value of the opportunity

forecastExpectedCloseDatestring

Expected close date. Supported formats: YYYY/MM/DD, MM/DD/YYYY, YYYY-MM-DD, MM-DD-YYYY, YYYY.MM.DD, MM.DD.YYYY, or ISO 8601

forecastProbabilitynumber

Forecast probability

assignedTostring

Identifier of the user the opportunity is assigned to

customFieldsobject[]

Add custom fields to opportunities.

Example (auto)

{
  "pipelineId": "VDm7RPYC2GLUvdpKmBfC",
  "locationId": "ve9EPM428h8vShlRW1KT",
  "name": "First Opps",
  "pipelineStageId": "7915dedc-8f18-44d5-8bc3-77c04e994a10",
  "status": "open",
  "contactId": "mTkSCb1UBjb5tk4OvB69",
  "monetaryValue": 220,
  "forecastExpectedCloseDate": "2026-04-23",
  "forecastProbability": 20,
  "assignedTo": "082goXVW3lIExEQPOnd3",
  "customFields": [
    {
      "id": "6dvNaf7VhkQ9snc5vnjJ",
      "fieldValue": "9039160788"
    }
  ]
}

application/json

Successful response

application/json

Schema

Schema

opportunityobject

The created or retrieved opportunity object

Example (auto)

{
  "opportunity": {}
}