Skip to content
Primary navigation

Delete group

admin.organization.groups.delete(strgroup_id) -> GroupDeleteResponse
DELETE/organization/groups/{group_id}

Deletes a group from the organization.

ParametersExpand Collapse
group_id: str
ReturnsExpand Collapse
class GroupDeleteResponse:

Confirmation payload returned after deleting a group.

id: str

Identifier of the deleted group.

deleted: bool

Whether the group was deleted.

object: Literal["group.deleted"]

Always group.deleted.

Delete group

import os
from openai import OpenAI

client = OpenAI(
    admin_api_key=os.environ.get("OPENAI_ADMIN_KEY"),  # This is the default and can be omitted
)
group = client.admin.organization.groups.delete(
    "group_id",
)
print(group.id)
{
    "object": "group.deleted",
    "id": "group_01J1F8ABCDXYZ",
    "deleted": true
}
Returns Examples
{
    "object": "group.deleted",
    "id": "group_01J1F8ABCDXYZ",
    "deleted": true
}