Update an opportunity

View as Markdown
*status_id* - See description for `status_id` in `POST /opportunity/` above. - 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`. *date_won* (optional): - If not set on the resource or in the request, the `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. *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

Basic authentication of the form Basic <base64(username:)>.

OR
AuthorizationBearer

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

Path parameters

idstringRequired

Request

This endpoint expects any.

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
organization_idstring
status_idstring
updated_bystring or null
user_idstring
valueinteger or null
value_periodenum
Allowed values:
attachmentslist of objects
comment_summaryobject or null
contact_namestring or null
created_by_namestring or null
is_stalledboolean
lead_namestring or null
lead_primary_emailobject or null
lead_primary_phonelist of objects or null
pipeline_idstring or null
pipeline_namestring or null
stall_statusobject or null
status_display_namestring
status_labelstring
status_typeenum
Allowed values:
suggested_actionobject or null
updated_by_namestring or null
user_namestring or null
value_currencystring or null
value_formattedstring or null

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error