Create a new OpportunityStatusChange activity

POST

https://api.close.com/api/v1/activity/status_change/opportunity/

POST

/api/v1/activity/status_change/opportunity/

$ curl -X POST https://api.close.com/api/v1/activity/status_change/opportunity/ \
>      -H "Content-Type: application/json" \
>      -u "<CLOSE_API_KEY>:" \
>      -d '{
>   "date_created": "2013-08-23T20:57:45.956000+00:00",
>   "lead_id": "lead_fioU1Nk5LC0H0iei9XBGHW2CFZU0yeP2zZCJQP9pC4m",
>   "new_status_id": "stat_DetsqwxFOOHx2JnhqtovutN3zeuARGfzB21x5t1W88G",
>   "old_status_id": "stat_ue534UFRaocoMJJA9CYCwnMsRJP2qt6YGnpZOAx7ckK",
>   "opportunity_id": "oppo_fn2kSFXS06akJ7XisR7vQQeObyK4upCc43RiAx1Vyz6"
> }'

1 {
2   "_type": "OpportunityStatusChange",
3   "activity_at": "2013-08-23T21:21:11.862000+00:00",
4   "contact_id": null,
5   "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
6   "date_created": "2013-08-23T21:21:11.862000+00:00",
7   "date_updated": "2013-08-23T21:21:11.862000+00:00",
8   "id": "acti_CAI2lO44gRLMIvgsKfPZghRyuv1h8S3l7c4cDznXukd",
9   "lead_id": "lead_0VaTsortzKpCv1ik6hbNoudduuD0m2Itevet0fKX39G",
10   "new_status_id": "stat_DetsqwxFOOHx2JnhqtovutN3zeuARGfzB21x5t1W88G",
11   "old_status_id": "stat_ue534UFRaocoMJJA9CYCwnMsRJP2qt6YGnpZOAx7ckK",
12   "opportunity_id": "oppo_fn2kSFXS06akJ7XisR7vQQeObyK4upCc43RiAx1Vyz6",
13   "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
14   "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
15   "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
16   "users": [],
17   "created_by_name": "Anthony Nemitz",
18   "new_pipeline_id": "pipe_6gV01if4wo7r2YTVQDWP2j",
19   "new_pipeline_name": "Sales",
20   "new_status_label": "Won",
21   "new_status_type": "won",
22   "old_pipeline_id": "pipe_6gV01if4wo7r2YTVQDWP2j",
23   "old_pipeline_name": "Sales",
24   "old_status_label": "Active",
25   "old_status_type": "active",
26   "opportunity_confidence": 100,
27   "opportunity_date_won": "2013-08-23T00:00:00+00:00",
28   "opportunity_value": 0,
29   "opportunity_value_currency": "USD",
30   "opportunity_value_formatted": null,
31   "opportunity_value_period": "one_time",
32   "updated_by_name": "Anthony Nemitz",
33   "user_name": "Anthony Nemitz"
34 }

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.

Authentication

AuthorizationBasic

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

AuthorizationBearer

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

Request

This endpoint expects any.

Response

Successful response

_typestring

activity_atdatetime or null

contact_idstring or null

created_bystring or null

date_createddatetime

date_updateddatetime

idstring

lead_idstring or null

new_status_idstring

old_status_idstring

opportunity_idstring or null

organization_idstring

updated_bystring or null

user_idstring or null

userslist of strings

created_by_namestring or nullOptional

new_pipeline_idstringOptional

new_pipeline_namestringOptional

new_status_labelstringOptional

new_status_typeenumOptional

old_pipeline_idstringOptional

old_pipeline_namestringOptional

old_status_labelstringOptional

old_status_typeenumOptional

opportunity_confidenceinteger or nullOptional

opportunity_date_wondatetime or nullOptional

opportunity_valueinteger or nullOptional

opportunity_value_currencystring or nullOptional

opportunity_value_formattedstring or nullOptional

opportunity_value_periodenum or nullOptional

updated_by_namestring or nullOptional

user_namestring or nullOptional

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error