Creates a new customer group for a business.
The request must include the name value of the group.
643 matches
100 actions
Square Connect
100 actions
Other/Square Connect
Creates a new customer group for a business.
The request must include the name value of the group.
{
"type": "object",
"description": "Defines the body parameters that can be included in a request to the\n[CreateCustomerGroup](https://developer.squareup.com/reference/square_2021-08-18/customer-groups-api/create-customer-group) endpoint.",
"required": [
"group"
],
"properties": {
"group": {
"type": "object",
"description": "Represents a group of customer profiles. \n\nCustomer groups can be created, be modified, and have their membership defined using \nthe Customers API or within the Customer Directory in the Square Seller Dashboard or Point of Sale.",
"required": [
"name"
],
"properties": {
"created_at": {
"type": "string",
"description": "The timestamp when the customer group was created, in RFC 3339 format."
},
"id": {
"type": "string",
"description": "A unique Square-generated ID for the customer group."
},
"name": {
"type": "string",
"description": "The name of the customer group."
},
"updated_at": {
"type": "string",
"description": "The timestamp when the customer group was last updated, in RFC 3339 format."
}
}
},
"idempotency_key": {
"type": "string",
"description": "The idempotency key for the request. For more information, see [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency)."
}
}
}{
"type": "object",
"description": "Defines the fields that are included in the response body of\na request to the [CreateCustomerGroup](https://developer.squareup.com/reference/square_2021-08-18/customer-groups-api/create-customer-group) endpoint.\n\nEither `errors` or `group` is present in a given response (never both).",
"properties": {
"errors": {
"type": "array",
"description": "Any errors that occurred during the request.",
"items": {
"type": "object",
"description": "Represents an error encountered during a request to the Connect API.\n\nSee [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) for more information.",
"required": [
"category",
"code"
],
"properties": {
"category": {
"type": "string",
"description": "The high-level category for the error."
},
"code": {
"type": "string",
"description": "The specific code of the error."
},
"detail": {
"type": "string",
"description": "A human-readable description of the error for debugging purposes."
},
"field": {
"type": "string",
"description": "The name of the field provided in the original request (if any) that\nthe error pertains to."
}
}
}
},
"group": {
"type": "object",
"description": "Represents a group of customer profiles. \n\nCustomer groups can be created, be modified, and have their membership defined using \nthe Customers API or within the Customer Directory in the Square Seller Dashboard or Point of Sale.",
"required": [
"name"
],
"properties": {
"created_at": {
"type": "string",
"description": "The timestamp when the customer group was created, in RFC 3339 format."
},
"id": {
"type": "string",
"description": "A unique Square-generated ID for the customer group."
},
"name": {
"type": "string",
"description": "The name of the customer group."
},
"updated_at": {
"type": "string",
"description": "The timestamp when the customer group was last updated, in RFC 3339 format."
}
}
}
}
}