Create outlet client group.

posthttps://core-api.ancon.io/api/v1/Outlets/{outletId}/ClientGroups

View .md OpenAPI

Authorization

Access-Tokenheaderrequired
Tenant- or outlet-level token from the backoffice. See Get started.

Path parameters

outletIdstring (uuid)required

Header parameters

correlationIdstring
Correlation Id for the request

Request body application/json

namestringrequired
Name of outlet client group
costCenterstringrequired
CostCenter of outlet client group
projectstringrequired
Project of outlet client group
clientIdsarray<string (uuid)> | null
Ids of outlet clients
custom1string | null
custom2string | null
custom3string | null
custom4string | null
custom5string | null

Responses

201Createdapplication/json

clientGroupobject | null
13 fields in clientGroup
- idstring (uuid)
- createdstring (date-time)
- modifiedstring (date-time)
- outletIdstring (uuid)
- namestring | null
- costCenterstring | null
- projectstring | null
- clientsarray<object> | null
  3 fields in clients
  - idstring (uuid)
  - namestring | null
  - clientTypeinteger (int32)
    Allowed values: 0, 1, 2, 3, 4, 5, 6, 7, 8.
- custom1string | null
- custom2string | null
- custom3string | null
- custom4string | null
- custom5string | null

401Unauthorizedapplication/json

messagestring | null

Request

curl -X POST "https://core-api.ancon.io/api/v1/Outlets/{outletId}/ClientGroups" \
  -H "Access-Token: $ANCON_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "POS group 1",
  "costCenter": "9668",
  "project": "2665",
  "clientIds": [
    "2a9c3317-3c30-4ae9-bceb-b30af95fff3d",
    "8f13da22-1d3b-4a39-a266-e1f3331763c6"
  ],
  "custom1": null,
  "custom2": null,
  "custom3": null,
  "custom4": null,
  "custom5": null
}'

Body

{
  "name": "POS group 1",
  "costCenter": "9668",
  "project": "2665",
  "clientIds": [
    "2a9c3317-3c30-4ae9-bceb-b30af95fff3d",
    "8f13da22-1d3b-4a39-a266-e1f3331763c6"
  ],
  "custom1": null,
  "custom2": null,
  "custom3": null,
  "custom4": null,
  "custom5": null
}

Response

{
  "clientGroup": {
    "id": "b3c73d96-05be-4770-9798-fe515557e537",
    "created": "2026-10-23T14:33:34.1481772Z",
    "modified": "2026-10-23T14:33:34.1481777Z",
    "outletId": "9488bd53-bc13-4315-97c2-b84f66c00553",
    "name": "POS Group",
    "costCenter": "9668",
    "project": "2665",
    "clients": [
      {
        "id": "38d6e31f-881f-4088-9ded-096ceebbed80",
        "name": "POS Licence 1",
        "clientType": 0
      },
      {
        "id": "4bed261e-1069-4f0a-a326-259ee0bba7aa",
        "name": "POS Licence 2",
        "clientType": 0
      }
    ],
    "custom1": null,
    "custom2": null,
    "custom3": null,
    "custom4": null,
    "custom5": null
  }
}

#Authorization

#Path parameters

#Header parameters

#Request body application/json

#Responses

Authorization

Path parameters

Header parameters

Request body application/json

Responses