Delete an Opportunity
Delete an opportunity by passing theOpportuityIdin the query string. To obtain theOpportuityId, please refer to Get Opportunity Types or Get Opportunities by Lead Id.
Note: You must enable “Allow Delete” while creating an opportunity type, in order for this API to work. To know how to do this, please refer to Opportunity Configurations.
API URL
URL
GET
https://{host}/v2/OpportunityManagement.svc/Delete?accessKey=AccessKey&secretKey=SecretKey&Id=Id
URL Parameters
| Parameter | Description |
|---|---|
| Id | Id of the opportunity. |
Response
200 OK
Content-Type: application/json
{
"Status":"Success",
"Message":{
"IsSuccessful":true
}
}
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. |
