CLclose
opportunities

Update an opportunity

Changed on

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" }
put/opportunity/{id}/

Request

  • Base URL
    https://api.close.com/api/v1
  • URL
    https://api.close.com/api/v1/opportunity/{id}/
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://app.close.com/oauth2/authorize/
      Token URL: https://api.close.com/oauth2/token/

Path parameters

idstring required

Request body

confidenceinteger
contact_idstring nullable
date_wonstring date-time nullable

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.

notestring

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 nullable

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.

statusstring
status_idstring

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 nullable
valueinteger

Monetary value of the opportunity in cents, e.g. 340000 for $3,400.00. The currency is the organization's currency.

value_period'one_time' | 'monthly' | 'annual'

Response

Successful response

annualized_expected_valueinteger nullable required

Annualized expected value in cents.

annualized_valueinteger nullable required

Annualized value in cents.

confidenceinteger required
contact_idstring nullable required
contact_namestring nullable
created_bystring nullable required
created_by_agent_idstring nullable

ID of the agent that created the opportunity, or null if no agent created it.

created_by_namestring nullable
date_createdstring date-time required
date_loststring date-time nullable required
date_updatedstring date-time required
date_wonstring date nullable required
expected_valueinteger nullable required

Value multiplied by confidence, in cents.

idstring required
is_stalledboolean
lead_idstring required
lead_namestring nullable
notestring nullable required
note_htmlstring nullable required
organization_idstring required
pipeline_idstring nullable
pipeline_namestring nullable
status_display_namestring
status_idstring required
status_labelstring
status_type'won' | 'lost' | 'active'
updated_bystring nullable required
updated_by_agent_idstring nullable

ID of the agent that last updated the opportunity, or null if the last update wasn't made by an agent.

updated_by_namestring nullable
user_idstring required
user_namestring nullable
valueinteger nullable required

Monetary value of the opportunity in cents, e.g. 340000 for $3,400.00. See value_formatted for a human-readable version.

value_currencystring nullable
value_formattedstring nullable
value_period'one_time' | 'monthly' | 'annual' required

Changes

  • 8e360c61058cRevision changes
    • info

      added the pattern property ^custom\.(cf|lcf|ccf|acf|gcf|scf)_[A-Za-z0-9]+$ to the response body for the status

  • 7bdb9cfcca22Revision changes
    • breaking

      added the pattern property ^custom\.(cf|lcf|ccf|acf|gcf|scf)_[A-Za-z0-9]+(\.(add|remove))?$ to the request body

    • info

      removed the pattern property ^custom\. from the request body