Skip to content
Primary navigation

Delete group

$ openai admin:organization:groups delete
DELETE/organization/groups/{group_id}

Deletes a group from the organization.

ParametersExpand Collapse
--group-id: string

The ID of the group to delete.

ReturnsExpand Collapse
AdminOrganizationGroupDeleteResponse: object { id, deleted, object }

Confirmation payload returned after deleting a group.

id: string

Identifier of the deleted group.

deleted: boolean

Whether the group was deleted.

object: "group.deleted"

Always group.deleted.

Delete group

openai admin:organization:groups delete \
  --admin-api-key 'My Admin API Key' \
  --group-id group_id
{
    "object": "group.deleted",
    "id": "group_01J1F8ABCDXYZ",
    "deleted": true
}
Returns Examples
{
    "object": "group.deleted",
    "id": "group_01J1F8ABCDXYZ",
    "deleted": true
}