Skip to content

Mass Delete Customer Groups

Deletes several customer groups in one request. The response reports which ids were deleted and which were skipped (with a reason).

EndpointMethod
/api/admin/customers/groups/mass-deletePOST

Request Body

FieldTypeRequiredDescription
indicesinteger[]yesGroup IDs to delete. Empty → 422.

Response Fields

FieldTypeDescription
deletedinteger[]IDs that were removed.
skippedobject[]{ id, reason } for IDs refused (system group or has customers attached).
messagestringSummary message.

System-group + in-use guards skip per-id with a reason rather than failing the whole batch. Permission: customers.groups.delete.

TIP

For the system-group and in-use delete rules, see the Customer Groups overview.

Released under the MIT License.