Customer Groups API

You are viewing an old version of the API

2021-07-21

Version 2021-07-21

• All Versions

Customer Groups API

Create customer group

Request Body

Example code

Name	Description
idempotency_key string	The idempotency key for the request. For more information, see Idempotency.
group CustomerGroup Required	The customer group to create. Show Attributes

Response Fields

Name	Description
errors Error [ ]	Any errors that occurred during the request. Show Attributes
group CustomerGroup	The successfully created customer group. Show Attributes

curl https://connect.squareup.com/v2/customers/groups \
  -X POST \
  -H 'Square-Version: 2021-07-21' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "group": {
      "name": "Loyal Customers"
    }
  }'

{
  "group": {
    "id": "2TAT3CMH4Q0A9M87XJZED0WMR3",
    "name": "Loyal Customers",
    "created_at": "2020-04-13T21:54:57.863Z",
    "updated_at": "2020-04-13T21:54:58Z"
  }
}