API reference · Customers · Customer Groups

Delete Customer Group

Method: DELETE
Route: /customer/group
Base URL: https://ws.autorei.net
Token: Requires Bearer token

Opens this request in the public API documentation, the official source of the reference.

Description

Deletes a customer group from your store. The customers who were in the group remain registered — what is removed is the group and the links to it.

Request body (JSON)

Field	Type	Required	Description
`externalId`	string	Yes	Group id in your system, the same one provided on creation.

Response · 200

The same envelope as creation, with action: "DELETE" and the message Grupo deletado com sucesso.

Field	Type	Description
`status`	string	`SUCCESS`.
`message`	string	Operation confirmation.
`action`	string	`CREATE` or `DELETE`.
`dateHour`	string	Operation date and time, in UTC.
`responsable.user`	string	Email of the token's user.
`responsable.origin`	string	`API`.
`group.internalId`	integer	Internal group id.
`group.name`	string	Group name.
`group.externalId`	string	External id. `null` when not provided.
`group.groupTypeId` · `group.groupTypeName`	string	Group type. `null` when not linked.

Errors

Code	When
400	`externalId` missing, or group does not exist. The reason comes in the message, in the same error envelope as creation, with `status: "ERROR"`.
401	Token missing, malformed or expired.

Example request

curl --request DELETE 'https://ws.autorei.net/customer/group' \
  --header 'Authorization: Bearer {{access_token}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "externalId": "GRP-ATC-SE"
}'

Example responses

200Success — group deleted

{
  "status": "SUCCESS",
  "message": "Grupo deletado com sucesso.",
  "action": "DELETE",
  "dateHour": "2026-09-04T12:15:16Z",
  "responsable": {
    "user": "integracao@lojaexemplo.com.br",
    "origin": "API"
  },
  "group": {
    "internalId": 4470801,
    "name": "Atacado Sudeste",
    "externalId": "GRP-ATC-SE",
    "groupTypeId": null,
    "groupTypeName": null
  }
}

Used in

This endpoint does not appear in any published use case yet.

GET List Customer Groups /customer/group/byGroup
POST Create Customer Group /customer/group
PUT Link Customer to a Group /customer/:document/priceType/:customerGroupId
DELETE Unlink Customer from a Group /customer/:document/priceType/:customerGroupId

← See the group: Customers

Generated from the public API collection, published on 2026-09-04: api-docs.cws.digital.