Update Opportunity

PUT 
/opportunities/:id

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Update Opportunity

Request

Version stringrequired

API Version

Available options2023-02-21

id stringrequired

Opportunity Id

application/json

application/json

Body

Bodyrequired

pipelineIdstring

pipeline Id

namestring

Name of the opportunity

pipelineStageIdstring

Identifier of the pipeline stage

statusstring
Current status of the opportunity
Available optionsopenwonlostabandonedall
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[]

Update custom fields to opportunities.

Example (auto)

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

application/json

Successful response

application/json

Schema

Schema

opportunityobject

The created or retrieved opportunity object

Example (auto)

{
  "opportunity": {}
}