Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

SalesOpportunities

Update a sales opportunity

Update a sales opportunity (required scope finance:write)

patch/v1/finance/salesOpportunities/{salesOpportunityId}

Path parameters

salesOpportunityIdinteger required

The id of the sales opportunity to update

Headers

Customer-Idinteger required

The customer identifier

Request body

subjectstring

The subject of the sales opportunity<br/><br/>Optional: Omit to retain current value

status'created' | 'onHold' | 'completedWon' | 'completedLost'

Represents the status of a sales opportunity.<p>Possible values:</p><ul><li><b>created</b>: The sales opportunity has been created.</li><li><b>onHold</b>: The sales opportunity is on hold.</li><li><b>completedWon</b>: The sales opportunity has been completed and won.</li><li><b>completedLost</b>: The sales opportunity has been completed and lost.</li></ul>

dueAtstring date-time

The due date of the sales opportunity<br/><br/>Optional: Omit to retain current value

stageIdinteger

The unique identifier of the stage associated with the sales opportunity<br/><br/>Optional: Omit to retain current value

probabilityIdinteger

The unique identifier of the probability associated with the sales opportunity<br/><br/>Optional: Omit to retain current value

notesstring

Notes associated with the sales opportunity<br/><br/>Optional: Omit to retain current value

referencestring nullable

The reference for the sales opportunity<br/><br/>Optional: Omit to retain current value or provide null to unset

Example request

{
  "subject": "New office equipment deal",
  "status": "created",
  "dueAt": "2025-06-30T00:00:00.0000000+00:00",
  "stageId": 3,
  "probabilityId": 2,
  "notes": "Customer is interested in bulk pricing",
  "reference": "SO-2025-001",
  "customFields": [
    {
      "definitionId": 5514123,
      "value": "High net worth"
    }
  ]
}

Response

No Content