Square API
You are viewing an old version of the API
Customer Groups
Square API
Programmatically create and manage customer groups to streamline and automate workflows, and to enable more personalized customer interactions.
The Customer Groups API lets you create and manage customer groups to provide targeted promotions or take other customized actions based on customers' group memberships. For example, you could create Weekly, Monthly and Quarterly customer groups and add customers to them based on their preferences to receive marketing promotions on a weekly, monthly and quarterly basis, respectively. You could then send marketing emails to customers in the Weekly group every Wednesday, to those in the Monthly group the first day of each month, and to those in the Quarterly group every three months.
The Customer Groups API enables you to retrieve and manage customer groups, while you can add and remove customers from groups and search for customers based on group membership using the Customers API.
Endpoints
-
Beta
List customer groups
GET /v2/customers/groups - Retrieves the list of customer groups of a business.
-
Beta
Create customer group
POST /v2/customers/groups - Creates a new customer group for a business.
-
Beta
Delete customer group
DELETE /v2/customers/groups/{group_id} - Deletes a customer group as identified by the group_id value.
-
Beta
Retrieve customer group
GET /v2/customers/groups/{group_id} - Retrieves a specific customer group as identified by the group_id value.
-
Beta
Update customer group
PUT /v2/customers/groups/{group_id} - Updates a customer group as identified by the group_id value.