Create Customer Group

Creates a new customer group. The response is the created group.

Endpoint	Method
/api/admin/customers/groups	POST

Request Body

Field	Type	Required	Description
code	string	yes	Unique. Validated by Webkul\Core\Rules\Code (regex ^[a-zA-Z]+[a-zA-Z0-9_]+$).
name	string	yes

System groups

New groups are always created with is_user_defined=1. The API cannot create system groups.

Permission: customers.groups.create.

TIP

For what customer groups are and the system-group rules, see the Customer Groups overview.