DELETE / contacts/delete
Base URL: https://backend.easify.app/api/v2
This endpoint is used to delete a contact.
The user can delete a specific contact from the database by using the contact's ID.
There is a rate limit of 60 requests per minute. If you exceed this limit, you will receive a 429 Too Many Requests status, along with a message indicating when you can try again.
Authentication
The Easify API token used for authentication is passed in the header as a Bearer token, which can be obtained from the easify app under Settings > API Settings.
Headers
Authorization string required Bearer << YOUR_EASIFY_API_TOKEN_HERE >>
Request Body
| contact_id integer | The specific contact ID to delete (The contact IDwill be obtained from the contacts API response) | Required |
Sample Params and Success Response:
params
{
"contact_id": 1
}
Success Response:
{
"status": true,
"message": "Contact deleted successfully",
"data": []
}
- The shared_contact is a Boolean field that indicates whether the contact is in the main user's shared contact group
Api Response Status
| Case | Status Code | Response |
|---|---|---|
| If the user does not provide a token in the header or provides an invalid token | 401 |
{
"status":false,
"message":"Unauthenticated",
"errors":[]
}
|
| If user did not provide the contact_id | 422 |
{ "message": "The contact id field is required.",
"errors": {
contact_id": "The contact field is required."]
}
}
|
| If the user provides invalid contact_id | 400 |
{
"status": false,
"message": "Invalid contact id",
"errors": []
}
|
| If the user exceeds the allowed rate limit for requests | 429 |
{
"status":false,
"message":"Too many requests. Try again in 59 seconds",
"errors":[]
}
|
| If the user's subscription has ended | 402 |
{
"status":false,"message":"You need to recharge your account to proceed","errors":[]
}
|
| If the user does not have an enterprise plan | 403 |
{
"status": false,
"message": "Access denied. Your current plan does not allow access to this feature. Please upgrade to the Enterprise plan.",
"errors": []
}
|
PHP-cURL
php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'https://backend.easify.app/api/v2/contacts/delete?contact_id=2812387',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer 1955|43da5bb5-5c2b-4059-a4de-d44bf5c****'
],
]);
$response = curl_exec($curl);
curl_close($curl);
echo $response;