Add Customer Group

Creates a new customer group to categorize customers based on certain criteria. Each customer group will have a name and description.

Endpoint

POST https://api.xtrakit.com/api/v1/customer-groups/add

Headers

Authorization: Bearer API_KEY

Body Parameters

Parameters	Type	Description
group_name string	Required	The name of the customer group. Typically short, identifying the purpose of the group.
group_description string	Optional	A detailed description explaining the group and its purpose. Can include criteria and benefits.

Sample Requests

PHP

<?php

$data = [
  'group_name' => "Platinum Customers", 
  'group_description' => "Customers who have spent over $5000 and have been with the business for over a year."
];

$url = 'https://api.xtrakit.com/api/v1/customer-groups/add';

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => $url,
  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 => $data,
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer API_KEY',  // Replace 'API_KEY' with your actual API key
    'Content-Type: application/json'  
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

?>

NodeJS

Python

Sample Response

Success

{
    "status": 200,
    "message": "Group added successfully",
    "data": {
        "group": {
            "id": 2,
            "group_name": "Platinum Customers",
            "group_description": "Customers who have spent over $5000 and have been with the business for over a year.",
            "created_at": "2024-08-04 08:23:45",
            "updated_at": "2024-08-04 02:00:43"
        }
    }
}

Error