CRM CoreOpportunities

Update an opportunity

View as Markdown
**custom.FIELD_ID** (optional) - See description for `custom.FIELD_ID` in `POST /opportunity/` above. - Additionally, you can unset a single field by using `{ "custom.FIELD_ID": null }`, e.g.: ``` { "custom.cf_v6S011I6MqcbVvB2FA5Nk8dr5MkL8sWuCiG8cUleO9c": null } ``` If you're trying to update a custom field and that custom field accepts multiple values, you can also specify `.add` or `.remove` as part of the field key to add/remove a single value to/from a list of values, e.g.: ``` { "custom.cf_v6S011I6MqcbVvB2FA5Nk8dr5MkL8sWuCiG8cUleO9c.add": "Wednesday" } ```

Authentication

AuthorizationBasic
Use your API key as the username and leave the password empty.
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Request

This endpoint expects an object.
attachmentslist of objectsOptional
confidenceintegerOptional
contact_idstring or nullOptional
date_wondatetime or nullOptional

If not set on the resource or in the request, date_won will be set automatically to today’s date when setting status_id to a status with type won. The x-tz-offset header, used to pass your timezone’s UTC offset, will be taken into account.

notestringOptional

Plaintext/markdown version of the note. If note_html is also provided in the same request, this value is ignored and note is derived from the HTML instead.

note_htmlstring or nullOptional

Rich-text HTML version of the note. When set, note is automatically populated with the plaintext version (tags become markdown), overriding any note value passed in the same request. Pass null to clear note_html; note is cleared as well.

statusstringOptional
status_idstringOptional

Setting the status_id to a status with a type of won will automatically set the date_won field if it is not already set or provided in the request. Reverting it from a won status to an active or lost will not automatically change date_won.

user_idstring or nullOptional
valueintegerOptional
value_periodenumOptional

Response

Successful response
annualized_expected_valueinteger or null
annualized_valueinteger or null
confidenceinteger
contact_idstring or null
created_bystring or null
date_createddatetime
date_lostdatetime or null
date_updateddatetime
date_wondate or null
expected_valueinteger or null
idstring
lead_idstring
notestring or null
note_htmlstring or null
organization_idstring
status_idstring
updated_bystring or null
user_idstring
valueinteger or null
value_periodenum
attachmentslist of objectsOptional
comment_summaryobject or nullOptional
contact_namestring or nullOptional
created_by_namestring or nullOptional
is_stalledbooleanOptional
lead_namestring or nullOptional
lead_primary_emailobject or nullOptional
lead_primary_phonelist of objects or nullOptional
pipeline_idstring or nullOptional
pipeline_namestring or nullOptional
stall_statusobject or nullOptional
status_display_namestringOptional
status_labelstringOptional
status_typeenumOptional
suggested_actionobject or nullOptional
updated_by_namestring or nullOptional
user_namestring or nullOptional
value_currencystring or nullOptional
value_formattedstring or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error