Skip to content
Primary navigation

Delete group

admin.organization.groups.delete(group_id) -> GroupDeleteResponse { id, deleted, object }
DELETE/organization/groups/{group_id}

Deletes a group from the organization.

ParametersExpand Collapse
group_id: String
ReturnsExpand Collapse
class GroupDeleteResponse { id, deleted, object }

Confirmation payload returned after deleting a group.

id: String

Identifier of the deleted group.

deleted: bool

Whether the group was deleted.

object: :"group.deleted"

Always group.deleted.

Delete group

require "openai"

openai = OpenAI::Client.new(admin_api_key: "My Admin API Key")

group = openai.admin.organization.groups.delete("group_id")

puts(group)
{
    "object": "group.deleted",
    "id": "group_01J1F8ABCDXYZ",
    "deleted": true
}
Returns Examples
{
    "object": "group.deleted",
    "id": "group_01J1F8ABCDXYZ",
    "deleted": true
}