API ReferenceOpportunities

Update Opportunity

Update an existing opportunity. Supports partial updates. Updatable fields: - Standard fields (value, size, status, confidence, etc.) - Workflow fields (workflowId, phaseId) - Contact information (primaryEmail, primaryPhone) - Contacts (contact IDs only, no name, email, phone, etc.) - Custom fields (through custom object) Note: Updates are atomic - either all fields update or none do. > **Changing account association is not supported via update.** To move an opportunity to a different account, delete and re-create it under the new account. **Note:** The `/requests` path is an alias for `/opportunities` and will continue to work until users are individually notified and migrated.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

opportunityIdintegerRequired
Opportunity identifier

Query parameters

allow_new_optionsbooleanOptionalDefaults to false
Whether to allow creation of new dropdown options during record creation

Request

This endpoint expects an object.
titlestringRequired

Opportunity title/name

addresslist of stringsRequired

An array containing a single string, which represents the full opportunity location/address.

tradeslist of stringsRequired
Array of trade types
descriptionstring or nullOptional
Opportunity description
workflowIdinteger or nullOptional
ID of associated workflow
valuedoubleOptional
Project value
sizedoubleOptional
Project size
statusenumOptional

Status of the project:

  • ACTIVE - Project is active and in progress
  • ON_HOLD - Project is temporarily paused
  • CANCELLED - Project has been cancelled
  • COMPLETED - Project has been completed
Allowed values:
primaryEmailstringOptionalformat: "email"
Primary contact email
primaryPhonestringOptional
Primary contact phone
contactslist of integersOptional

Contact IDs only (no name, email, phone, etc.). The contacts must be created first via POST /contacts.

custommap from strings to anyOptional
Custom fields

Response

Opportunity updated successfully
idinteger
Unique identifier
createdAtstringformat: "date-time"
Creation timestamp
updatedAtstringformat: "date-time"
Last update timestamp
titlestring

Record title/name

descriptionstring or null
Record description
addresslist of strings

An array containing a single string, which represents the full opportunity location/address.

isActiveboolean
Whether the record is active
primaryEmailstring or nullformat: "email"
Primary contact email
primaryPhonestring or null
Primary contact phone
numberinteger
Sequential opportunity number
custommap from strings to any
Custom fields
tradeslist of strings
Array of trade types
valuedouble or null
Deal value
sizedouble or null
Deal size
confidencedouble or null

Deal confidence score (0-100)

workflowIdinteger or null
Associated workflow ID
accountIdinteger or null
Associated account ID
createdByIdinteger
Identifier of the user who created the opportunity
geoLocationlist of strings

Latitude/Longitude in “lat,lon” format

imageUrlstring or null
Image URL for the opportunity
streetViewUrlstring or null
Street view image URL
citystring
zipcodestring
statestring
streetstring
phaseobject or null
phaseInstanceslist of objects
Ordered list of phase instances for the opportunity
ownerobject or null
salesRepobject or null
projectManagerobject or null
jurisdictionobject or null
lastActivitystring or nullformat: "date-time"
phaseIdinteger or null
workflowNamestring
Name of the associated workflow.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error