Customer Client Groups

Customer client groups represent groupings of customer clients, used for organization, loyalty tiers, or special customer categorization. The file contains all groups (active, inactive, and deleted), with the status field carrying the lifecycle information.

Storage Location

{customer_id}-customer_client_group.json

Fields

Field	Type	Required	Description
id	number	Yes	v1.3. Group id.
customer_id	number	Yes	v1.3. Customer id the file belongs to.
name	string	Yes	v1.3. Group name.
status	string	Yes	v1.3. active, inactive, deleted or unknown.

Example

[
  {
    "id": 7,
    "customer_id": 10352,
    "name": "VIP",
    "status": "active"
  },
  {
    "id": 8,
    "customer_id": 10352,
    "name": "Staff",
    "status": "deleted"
  }
]

Related Entities

• Customers - Parent customer/tenant
• Customer Clients - Clients that belong to groups