Delete an Account
Lets you delete an existing company (account). You can also use this API to delete leads under the account –
- Pass “withLeadDelete”=true if you wish to delete all leads under the account.
- Pass “withLeadDelete”=false if you just want to delete the account. The leads will be disassociated from the account but not deleted in this case.
API URL
URL Parameters
Parameter | Description |
---|---|
CompanyId | Unique identifier of the company you want to delete. |
true or false | Pass "true" if you wish to delete all leads associated with the account as well. Pass "false" to only delete the account. |
Response
{ "Status": "Success", "Message": {} }
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. |