Delete Group

​

Delete a group. Its memberships and workshop item shares are removed; the users and items themselves are not affected.

Requires an API key for an MSP user whose role includes the Manage Groups permission. Tenant (company) users, including tenant admins, receive 403. Groups in tenants your MSP does not manage are never returned or changed.

Path Parameters

  • group_id
    Type: string
    required

    Group HashID

    Group HashID (e.g., group_abc123)

Responses

  • application/json
  • application/json
  • application/json
  • application/json
Request Example for delete/admin/groups/{group_id}
curl 'https://ai.hatz.ai/v1/admin/groups/{group_id}' \
  --request DELETE \
  --header 'X-API-Key: YOUR_SECRET_TOKEN'

{
  "message": "Group deleted successfully",
  "group_id": "group_X7VAK72dp5nX3Cd6JXwdPg6OxD"
}

Group deleted

Previous
Update Group
Next
AIModel