Update an Opportunity (Async)
This downloads our complete API collection, including all endpoints—not just this specific endpoint.
Updates an existing opportunity in your account. Functionality is the same as the synchronous Update an Opportunity API, with the following differences –
- API host is different, see Async API.
- The URL is slightly different (see API URL below).
- An additional
x-api-keymust be passed in the header, see Async API.Content-Typeisapplication-json. - Returns a
RequestIdparameter in the response. This must be passed in the Status API to get the status of the request. - To get metrics for this Async API, see Get Update Opportunity Metrics API.
API URL
URL
POST
https://{async-host}/opportunity/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 related to 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":"Request accepted. Please use below request id to check the status",
"RequestID":"7ba60ab0-7054-4856-8590-1b5a9f904ad1"
}
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. |
