The new user group (version 2) solves the use cases of both B2B loyalty and B2C loyalty unlike the previous version which was designed for B2C cases. This resource contains APIs to manage user groups.
Response Parameters
| Parameter | Datatype | Description |
|---|---|---|
| defaultGroup | boolean | Whether it is the default group for the customer. |
| active | boolean | Status of the customer. Internally, it is always true. |
| result | obj | Actual response schema. |
| userId | long | Unique ID of the customer/member. |
| groupId | int | Group ID to which the customer is added. |
| defaultGroup | boolean | Whether it is a default group for the customer. This will be true for the primary member. |
| permissions | array | Permissions of the member. |
Status Codes
Error Codes
| Code | Description |
|---|---|
| 403 | Field {x} is mandatory. |
| 1619 | Group id {x} is invalid |
| 1620 | User {x} does not belong to group {y}. |
| 1622 | Users does not belong to same company. |
| 1623 | User {x} already present in group {y}. |
| 1624 | Group transfer not allowed for primary member {x} |
| 1632 | Group id/externalId/primary userId {x} passed is not valid. |
| 1633 | Group external Id {x} already exists. |
| 1634 | Group externalId can't be null |
| 1635 | Group query param is not passed. |
| 1636 | Customer is already a member of the group. |
| 1637 | Primary member exists for the group. |
| 1638 | Total members in the group reached maximum group capacity {x}. |
| 1639 | Group max size can not exceed product limit {x} |
| 1640 | Group max size field should be a positive value. |
| 1641 | Invalid permission code {x} passed. |
| 1642 | User is primary member in a different group. |
| 1643 | Nothing to update in the group |
| 1644 | Group details not passed. |
| 1645 | Group details passed are not valid. |
| 8015 | Customer not found for the given identifiers. |
| 8069 | Merged customer found. |