Delete

Delete Single Group

DELETE - /v2/companies/<company_id>/groups/<group_id>

🚧

Warning

It should be noted that you can not delete a Group that has active Projects or People belonging to it. This is to prevent those entities from being "stranded" in the system if the group you are trying to delete is the single group they belong to. When you try to delete a Group that can not be deleted for this reason, you will be provided with a list of Project and People IDs that belong to this group so you can remove this group ID from those entities if you choose.

Responses:

Successful Response

Will return the Group ID of the just deleted group.

{"id": "aeee8fc5-b8ee-4bf0-bca9-86f751f99795"}

[400] Failed Response

Per the above warning about deleting Groups that are in use, you will receive the below response data if you try to.

Failed Response

{
  "code": "BadRequestError",
  "message": {
    "project_ids": ['2d2ad78e-c6de-467e-8413-c616b55294a5'],
    "people_ids": ['bc107873-b2fe-4f8f-9879-6d95b4a0684f', '94186279-fa66-42c6-a2ca-f44dde84f584']
  }
}