CLclose
activities.opportunity_status_changes

Create a new OpportunityStatusChange activity

Changed on

Creating an opportunity status change does not change the opportunity's status. It only logs the status change event. This should only be used to import historical status changes from another system.

post/activity/status_change/opportunity/

Request

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

Response

Successful response

_typestring required
activity_atstring date-time nullable required
contact_idstring nullable required
created_bystring nullable required
created_by_agent_idstring nullable
created_by_namestring nullable
date_createdstring date-time required
date_updatedstring date-time required
idstring required
lead_idstring nullable required
new_pipeline_idstring
new_pipeline_namestring
new_status_idstring required
new_status_labelstring
new_status_type'won' | 'lost' | 'active'
old_pipeline_idstring
old_pipeline_namestring
old_status_idstring required
old_status_labelstring
old_status_type'won' | 'lost' | 'active'
opportunity_confidenceinteger nullable
opportunity_date_wonstring date-time nullable
opportunity_idstring nullable required
opportunity_valueinteger nullable
opportunity_value_currencystring nullable
opportunity_value_formattedstring nullable
opportunity_value_period'one_time' | 'monthly' | 'annual'
organization_idstring required
updated_bystring nullable required
updated_by_agent_idstring nullable
updated_by_namestring nullable
user_idstring nullable required
user_namestring nullable
usersstring[] required

Changes

  • 2ff98656cc2aRevision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

  • 533de473c640Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status