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 the
OpportunityIdfor 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: If you created an AutoId field for the opportunity type, you can pass the AutoId value in the
ProspectOpportunityId paramater to update a specific opportunity.
Opportunity Id of the opportunity you want to update.
Notes associated with the Opportunity.
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 icon, and then click Edit. You’ll find the “Schema Names” for the opportunity fields here.
HTTP Response Codes
This is the status code for successful API call.
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.