This API method is used for deleting a contact.
| Parameter | Required | Type | Description |
|---|---|---|---|
| apikey | yes | string | Your authorized API key |
| secret | yes | string | Your authorized secret key |
| user_id | yes | string | Unique ID of the user |
| business_id | yes | number | Unique ID of the business |
| contacts | yes | string | Unique ID of the contact |
{
"status": "success",
"status_code": 200,
"message": "Contact has been removed",
"result": {
"_id": "xxxxxxxxxxxxx"
}
}
| Error Code | Description |
|---|---|
| 204 | No Record Found |
| 701 | User id parameter required |
| 702 | User id required |
| 701 | Business id parameter required |
| 702 | Business id required |
| 701 | Contact id parameter required |
| 702 | Contact id required |
| 613 | Invalid user and business |
{
"status": "no_record",
"status_code": 204,
"message": "No record found",
"result": {
"response_type": "No Content"
}
}
{
"error": {
"reason": "parameter missing",
"message": "User id parameter required",
"field_name": "user_id",
"code": 701,
"error_type": "missing_parameter"
}
}
{
"error": {
"reason": "required field",
"message": "User id is required",
"code": 702,
"error_type": "required"
}
}
{
"error": {
"reason": "parameter missing",
"message": "Business id parameter required",
"field_name": "business_id",
"code": 701,
"error_type": "missing_parameter"
}
}
{
"error": {
"reason": "required field",
"message": "Business id required",
"code": 702,
"error_type": "required"
}
}
{
"error": {
"reason": "parameter missing",
"message": "Contact id parameter required",
"field_name": "contact_id",
"code": 701,
"error_type": "missing_parameter"
}
}
{
"error": {
"reason": "required field",
"message": "Contact id is required",
"code": 702,
"error_type": "required"
}
}
{
"error": {
"reason": "Invalid user and business",
"message": "The business and user id combination that you provided doesn't match in our record",
"code": 613,
"error_type": "invalid_user_business"
}
}
Loading please wait...
