POST /v2/customers/groups
Creates a new customer group for a business.
The request must include the name
value of the group.
Servers
- https://connect.squareup.com
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
group |
Object | Yes |
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. |
group.id |
String | No |
A unique Square-generated ID for the customer group. |
group.name |
String | Yes |
The name of the customer group. |
group.created_at |
String | No |
The timestamp when the customer group was created, in RFC 3339 format. |
group.updated_at |
String | No |
The timestamp when the customer group was last updated, in RFC 3339 format. |
idempotency_key |
String | No |
The idempotency key for the request. For more information, see Idempotency. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.