create-customer-group-request.md

Create Customer Group Request

Defines the body parameters that can be included in a request to the CreateCustomerGroup endpoint.

Structure

CreateCustomerGroupRequest

Fields

Name	Type	Tags	Description
idempotencyKey	string | undefined	Optional	The idempotency key for the request. For more information, see Idempotency.
group	CustomerGroup	Required	Represents a group of customer profiles. Customer groups can be created, be modified, and have their membership defined using the Customers API or within the Customer Directory in the Square Seller Dashboard or Point of Sale.

Example (as JSON)

{
  "group": {
    "name": "Loyal Customers"
  }
}