Skip to content

Update an Opportunity

PUT https://api.prosperworks.com/developer_api/v1/opportunities/{{example_opportunity_id}}

Updates are only applied to fields explicitly specified in the request body. For example, if an update request is made with an empty body, no updates will be made. To remove the value from a field, the request body must specify the target field value as 'null'.

Request body

1
2
3
{
  "details":"This is an update"
}

Example Requests

Update Opportunity

1
2
3
4
5
6
7
8
curl --location --request PUT "https://api.prosperworks.com/developer_api/v1/opportunities/{{example_opportunity_id}}" \
  --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \
  --header "X-PW-Application: developer_api" \
  --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \
  --header "Content-Type: application/json" \
  --data "{
  \"details\":\"This is an update\"
}"
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
  "id": 2827698,
  "name": "8 New Copy Machines (sample)",
  "assignee_id": null,
  "close_date": "1/23/2017",
  "company_id": 9607580,
  "company_name": "Dunder Mifflin (sample)",
  "customer_source_id": 331241,
  "details": "This is an update",
  "loss_reason_id": null,
  "pipeline_id": 213214,
  "pipeline_stage_id": 987790,
  "primary_contact_id": null,
  "priority": "None",
  "status": "Open",
  "tags": [],
  "interaction_count": 0,
  "monetary_value": 250000,
  "win_probability": 5,
  "date_created": 1483988829,
  "date_modified": 1496776255,
  "custom_fields": [
    {
      "custom_field_definition_id": 100764,
      "value": null
    },
    {
      "custom_field_definition_id": 103481,
      "value": null
    }
  ]
}