put

/customer_groups/{customer_group_id}

Updates a Customer Group.

Notes

Any combination of fields can be updated at once. Discount rules are treated in bulk. The entire set of rules is overwritten when a request is sent.

Authorization

apiKey - X-Auth-Token
apiKey - X-Auth-Client

Request Parameters

1 Path Parameter
2 Headers

Request Body

3 Examples
Schema
object

When creating a customer group category discount using the API it defaults to “products in this category and its subcategories”. In the Control Panel this can be changed to either “products in this category only” or “products in this category and its subcategories”. There are currently no settings to change this behavior via API.

id
integer

Id of the customer group

1 validation
name
string

Name of the group

1 validation
is_default
boolean

Determines whether new customers are assigned to this group by default.

1 validation
category_access
object
discount_rules
array[object]

A collection of discount rules that are automatically applied to customers who are members of the group

is_group_for_guests
boolean

If the groups is for guests. There can only be one customer group for guests at a time.

Responses

2 Examples
Schema
object

When creating a customer group category discount using the API it defaults to “products in this category and its subcategories”. In the Control Panel this can be changed to either “products in this category only” or “products in this category and its subcategories”. There are currently no settings to change this behavior via API.

id
integer

Id of the customer group

1 validation
name
string

Name of the group

1 validation
is_default
boolean

Determines whether new customers are assigned to this group by default.

1 validation
category_access
object
discount_rules
array[object]

A collection of discount rules that are automatically applied to customers who are members of the group

is_group_for_guests
boolean

If the groups is for guests. There can only be one customer group for guests at a time.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
customer_group_id
$$.env
2 variables not set
store_hash
X-Auth-Token
X-Auth-Client