Upsert Opportunity

POST 
/opportunities/upsert

Upsert Opportunity

Request

Version stringrequired

API Version

Available optionsv3

application/json

application/json

Body

Bodyrequired

idstring

opportunityId

pipelineIdstringrequired

pipeline Id

locationIdstringrequired

locationId

followersstring[]required

contactId

isRemoveAllFollowersbooleanrequired

isRemoveAllFollowers

followersActionTypestringrequired
followers action type
Available optionsaddremove
namestring

name

statusstring
Current status of the opportunity
Available optionsopenwonlostabandonedall
pipelineStageIdstring

Identifier of the pipeline stage

monetaryValueobject

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

lostReasonIdstring

lost reason Id

Example (auto)

{
  "id": "yWQobCRIhRguQtD2llvk",
  "pipelineId": "bCkKGpDsyPP4peuKowkG",
  "locationId": "CLu7BaljjqrEjBGKTNNe",
  "followers": "LiKJ2vnRg5ETM8Z19K7",
  "isRemoveAllFollowers": true,
  "followersActionType": "add",
  "name": "opportunity name",
  "status": "open",
  "pipelineStageId": "7915dedc-8f18-44d5-8bc3-77c04e994a10",
  "monetaryValue": 220,
  "forecastExpectedCloseDate": "2026-04-23",
  "forecastProbability": 20,
  "assignedTo": "082goXVW3lIExEQPOnd3",
  "lostReasonId": "CLu7BaljjqrEjBGKTNNe"
}

application/json

Successful response

application/json

Schema

Schema

opportunityobjectrequired

Updated / New Opportunity

newbooleanrequired

Indicates whether the opportunity was newly created (true) or updated (false)

Example (auto)

{
  "opportunity": {},
  "new": true
}