DELETE / contact-groups/delete

Base URL: https://backend.easify.app/api/v2

This endpoint is used to delete a contact group.

The user can delete a specific contact group from the database using the group 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 >>

Query Parameters

group_id integer The specific contact group ID for update (Thegroup ID will be obtained from the contact-groups API response) required

Sample Params and Success Response

Params:

{
  "group_id": 1
}

Success Response:

{
  "status": true,
  "message": "Contact Group deleted successfully",
  "data": []
}

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 group_id 422 { "message": "The group id field is required.", "errors": { group_id": "The group id field is required."] } }
If user did not provide invalid group_id 400 { "status": false, "message": "Invalid group id", "errors": [] }
If a user tries to delete the default contact group. 400 { "status": false, "message": "You can't delete the default contact group!", "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/contact-groups/delete?group_id=2271',
    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;
pixel for linkedin