Edit Customer Group

Updates the information of an existing customer group, allowing changes to the name, description, and other fields.

Endpoint

PUT https://app.xtrakit.com/api/v1/customer-groups/{id}

Headers

Authorization: Bearer API_KEY

Path Parameters

Parameters	Type	Description
id string	Required	The unique identifier of the customer group. Should be passed through the URL

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
$id = 'CUSTOMER_GROUP_ID'; // Replace 'CUSTOMER_GROUP_ID' with your actual customer group ID

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

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

$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 => 'PUT',
  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

const axios = require('axios');

const id = 'CUSTOMER_GROUP_ID'; // Replace 'CUSTOMER_GROUP_ID' with your actual customer group ID

const data = {
  'group_name': "Premium Customers", 
  'group_description': "Customers who have spent over $1000 and have been with the business for over a year."
};

const config = {
    method: 'put',
    url: `https://app.xtrakit.com/api/v1/customer-groups/{id}`,
    headers: {
        'Authorization': 'Bearer API_KEY' // Replace 'API_KEY' with your actual API key
    },
    data: data 
};

axios(config).then(function(response) {
    console.log(JSON.stringify(response.data));
}).catch(function(error) {
    console.error(error);
});

Python

import requests

id = 'CUSTOMER_GROUP_ID' # Replace 'CUSTOMER_GROUP_ID' with your actual customer group ID

data = {
  'group_name': "Premium Customers", 
  'group_description': "Customers who have spent over $1000 and have been with the business for over a year."
}

url = f'https://app.xtrakit.com/api/v1/customer-groups/{id}'

headers = {
    "Authorization": "Bearer API_KEY" # Replace 'API_KEY' with your actual API key
}

try:
    response = requests.put(url, headers=headers, json=data)
    print(response.json())
except requests.exceptions.RequestException as e:
    print(e)

Sample Response

Success

{
    "status": 200,
    "message": "Group updated successfully",
    "data": {
        "group": {
            "id": 1,
            "user_id": "f93c5a51-ffa4-4aef-a45b-4cdec1c8cc10",
            "business_code": "15848484",
            "group_name": "Premium Customers",
            "group_description": "Customers who have spent over $1000 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

{
    "status": 401,
    "error": "Unauthorized: Missing Bearer Token"
},

{
    "status": 401,
    "error": "Unauthorized: Invalid API Key"
}