• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
Update customer group BETA

PUT /v2/customers/groups/{group_id}

Updates a customer group as identified by the group_id value.


Permissions
CUSTOMERS_WRITE
CUSTOMERS_READ
Try in API Explorer
Name Description
group_id
string

Required

The ID of the customer group to update.

Name Description
group
CustomerGroup

Required

The CustomerGroup object including all the updates you want to make.

Response Fields

Name Description
errors
Error [ ]

Any errors that occurred during the request.

group
CustomerGroup

The successfully updated customer group.

Examples

You are viewing an old version of the API
PUT /v2/customers/groups/{group_id}
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js
curl https://connect.squareup.com/v2/customers/groups/2TAT3CMH4Q0A9M87XJZED0WMR3 \
  -X PUT \
  -H 'Square-Version: 2020-11-18' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "group": {
      "name": "Loyal Customers"
    }
  }'
Response JSON
{
  "group": {
    "id": "2TAT3CMH4Q0A9M87XJZED0WMR3",
    "name": "Loyal Customers",
    "created_at": "2020-04-13T21:54:57.863Z",
    "updated_at": "2020-04-13T21:54:58Z"
  }
}

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?