Update Customer Group
PUT
/customers/groups/{group}This endpoint allows you to update a customer group by passing the group
as a path parameter.
Request
The Customer Group ID. List of Customer Group ID can be found here.
A unique title or label assigned to a collection of items, individuals, or entities that share common characteristics, serving as a means of categorization or identification within a broader context or organization. List of customers can be found here.
An array of conditions to consider when automatically assigning customers to a group.
The type of the condition.
A condition operator.
A condition value (value to be after the operator).
Refers to the minimum possible value. Required if symbol
equals between
.
Refers to the maximum possible value. Required if symbol
equals between
{
"name": "VIP",
"conditions": [
{
"type": "total_sales",
"symbol": "between",
"min_value": 100,
"max_value": 500
}
],
"features": {
"payment_method": [
"credit_card",
"mada",
"bank",
"cod",
"apple_pay",
"stc_pay"
],
"shipping": [
"all"
]
}
}
Request samples
[api.label.responses]
Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.
Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.
Detailed structure of the customer group model object showing its fields and data types.
The unique identifier assigned to a specific group of customers
The name or label for a the Customer Group.
Conditions for group membership, such as total_sales > 100
, determine auto-assignment. For example, customers with sales exceeding 100 are added to the group automatically.
{
"status": 200,
"success": true,
"data": {
"id": 21314237,
"name": "VIP"
}
}