(Quick Reference)
Service: Delete a contact
Description: Returns a json response.
URL:
https://BASE_URL/api/VERSION/contacts/{id}
Method: DELETE
Parameters:
Name | Description | Type | Required | Example values |
---|
id | The numerical ID of the desired contact | Long | yes | 123 |
Success Output
Success case: response.status=200
{
"success": "true",
"success_description": "Instance deleted successfully"
}
Failure Output
Failure case:response.status = 400
{
"error": "delete_failed",
"error_description": "Failed to delete instance."
}
Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The contact with the id 706 doesn't exist."
}