Update an Opportunity
Lets you update the fields in an existing opportunity. To use this API –
- Pass the
ProspectOpportunityId(or Prospect Id) in the API URL. You can get theOpportunityIdfor an opportunity by referring to Get Opportunity by Lead Id. - Pass the fields you want to update as attribute-value pairs in the JSON body. Only the fields you pass will be updated, other fields won’t be impacted.
Note:
- The supported DateTime format is UTC (YYYY-MM-DD HH:MM:SS).
- If you created an AutoId field for the opportunity type, you can pass the AutoId value in the
ProspectOpportunityIdparamater to update a specific opportunity.
API URL
URL
POST
https://{host}/v2/OpportunityManagement.svc/Update?accessKey=AccessKey&secretKey=SecretKey
Request
Content-Type: application/jsonJSON Body/Payload
{
"ProspectOpportunityId":"5ca5b042-51ea-4699-b6f0-84c40ab12770",
"OpportunityNote":"Update note",
"Fields":[
{
"SchemaName":"mx_Custom_6",
"Value":"200,000"
},
{
"SchemaName":"mx_Custom_7",
"Value":"180,000"
},
{
"SchemaName":"mx_Custom_8",
"Value":"2020-09-16 12:13:44"
}
]
}
Request Parameters
| Parameter | Description |
|---|---|
| ProspectOpportunityId | Opportunity Id of the opportunity you want to update. |
| OpportunityNote | Notes associated with the Opportunity. |
| Fields | The opportunity fields you want to update. Pass the fields as attribute-value pairs, mention the “Schema Names” and the values for it. To find the “Schema Names”, navigate to My Profile>Settings>Opportunities>Opportunity Types. Against the opportunity type, click the |
Response
200 OK
Content-Type: application/json
{
"Status": "Success",
"Message": {
"Id": "5ca5b042-51ea-4699-b6f0-84c40ab12770"
}
}
HTTP Response Codes
| Code | Description |
|---|---|
| 200 OK | This is the status code for successful API call. |
| 401 Unauthorized | The API call was made with invalid access credentials. Check your AccessKey and SecretKey. |
| 400 Bad Request | The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure. |
| 404 Not Found | The API could not be found. Please check the API signature. |
| 429 Too Many Requests | API calls exceeded the limit of 25 in 5 second(s) |
| 500 Internal Server Error | The API called failed. There could be many reasons for it. Check the exception message to get more details. |
