Square API
You are viewing an old version of the API
Customer Groups
Square API
Create and manage customer groups to streamline and automate workflows and help personalize customer interactions.
The Customer Groups API lets you create and manage customer groups to provide targeted promotions or take other customized actions based on group membership. For example, you can 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. You can then use the information to manage your marketing email schedule.
You can use the Customer Groups API to retrieve and manage customer groups. You can use the Customers API to add customers to and remove customers from groups and search for customers based on group membership.
Guides: Customer Groups
Endpoints
-
List customer groups
GET /v2/customers/groups - Retrieves the list of customer groups of a business.
-
Create customer group
POST /v2/customers/groups - Creates a new customer group for a business.
-
Delete customer group
DELETE /v2/customers/groups/{group_id} - Deletes a customer group as identified by the group_id value.
-
Retrieve customer group
GET /v2/customers/groups/{group_id} - Retrieves a specific customer group as identified by the group_id value.
-
Update customer group
PUT /v2/customers/groups/{group_id} - Updates a customer group as identified by the group_id value.