Customer Groups
Organizing customers into segments for targeting and management
Customer Groups
Customer groups let you segment customers into logical groups — VIPs, wholesale buyers, loyalty tiers, or any other classification that fits your business. Deleting a group does not delete the customers in it.
The Customer Group Object
{
"id": "grp_abc123xyz789",
"name": "VIP Customers",
"description": "High-value customers with premium benefits",
"created": "2024-01-15T10:30:00Z",
"updated": "2024-01-16T14:22:00Z"
}Fields
| Field | Type | Description |
|---|---|---|
id | string | Internal Linkit ID |
name | string | Group name (unique per organization) |
description | string | Optional description |
List Customer Groups
GET /api/v1/customer-groupsQuery Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
page | integer | 1 | Page number |
limit | integer | 20 | Items per page |
Example Request
curl -X GET "https://linkit.works/api/v1/customer-groups?page=1&limit=25" \
-H "Authorization: Bearer your_token_here"Create Customer Group
POST /api/v1/customer-groupsRequest Body
{
"name": "Loyalty Program - Gold",
"description": "Customers in the gold tier"
}Required Fields
| Field | Type | Constraints |
|---|---|---|
name | string | 1–100 chars, unique per organization |
Optional Fields
| Field | Type | Constraints |
|---|---|---|
description | string | Max 500 chars |
Update Customer Group
PUT /api/v1/customer-groups/{id}Delete Customer Group
DELETE /api/v1/customer-groups/{id}Deleting a group removes the group only. Customers are not affected — they are simply no longer associated with this group.
Error Responses
409 Conflict (Duplicate)
{
"code": 409,
"error": "Group with same name and description already exists",
"details": { "name": "VIP Customers" }
}422 Validation Error
{
"code": 422,
"error": "Validation error",
"details": "Name is required"
}