Skip to main content
POST
/
api
/
v1
/
{team_slug}
/
{app_slug}
/
customer-groups
Error
A valid request URL is required to generate request examples
{
  "data": {
    "app_id": "<string>",
    "created_at": "<string>",
    "discountPercentage": 123,
    "discountPercentageDecimals": 123,
    "id": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "storeGroupId": "<string>",
    "updated_at": "<string>"
  },
  "details": [
    "<string>"
  ],
  "success": true
}

Path Parameters

​
app_slug
string
required

App slug

​
team_slug
string
required

Team slug

Body

application/json

customer group details

​
name
string
required
​
slug
string
required
​
discountPercentage
integer

Customer groups either have discount or a store group. Both discountPercentage and discountPercentageDecimals are required for discount.

​
discountPercentageDecimals
integer

Customer groups either have discount or a store group. Both discountPercentage and discountPercentageDecimals are required for discount.

​
storeGroupId
string

Customer groups either have discount or a store group.

Response

customer group created successfully

​
data
object
​
details
string[]

Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes

​
success
boolean