Customers > Customer Groups > customerGroupsModify
Commerce APICustomersCustomer GroupscustomerGroupsModify
customerGroupsModify
POST:customer_groups.json

Description

Modify one or multple customer groups.

Permission bit: "customer_groups.modify"

Topic: Customer Groups

Arguments

data: [CustomerGroupModify!]!

Main argument for mutations.


ids: [String!]!

List of customer group ids. See also: Unique Identifiers

Example: ["cg_EQzGqWoY"]


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


Data Argument Fields

name: String

Name of the customer group

Example: "Retailers"

Valid when: name is not empty

Valid when: name's length doesn't exceed 250 characters


tax_exempt: Boolean

Makes all customers in the customer group as tax-exempt, customers will not be charged any taxes

Example: false


Result

[CustomerGroup!]

Preview (typescript)

Loading module