POST / contact-groups/create

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

This endpoint is used to create a new contact group.

The user can create a new contact group with a name of their choice.

There is a rate limit of 15 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

name string Specify the name for the contact group required

Sample Request and Success Response:

Request

{
  "name": "My Contact Group"
}

Success Response:

{
  "status": true,
  "message": "Contact Group created successfully",
  "data": {
    "id": 1,
    "name": "My Contact Group",
    "contacts_count": 0,
    "shared_group": false,
    "default_group": false,
    "created_at": "12-02-2024 03:13:35 AM"
  }
}
  • The contacts_count in the response refers to the total number of contacts in the specific contact group.
  • The shared_group is a Boolean field that specifies whether the contact group is the main user's shared contact group or not.
  • The default_group is a Boolean field that indicates whether the contact group is the user's default contact group in the Easify app

Responses

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 the user provides the name of an existing contact group 422 { "message": "The name has already been taken.", "errors": { "name": ["The name has already been taken."] } }
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/create',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => [
        'name' => 'easify contact'
    ],
    CURLOPT_HTTPHEADER => [
           'Accept: application/json',
           'Authorization: Bearer 1955|43da5bb5-5c2b-4059-a4de-d44bf5c8****'
    ],

]);

$response = curl_exec($curl);

curl_close($curl);

echo $response;
pixel for linkedin