Skip to content
Primary navigation

Delete group

GroupDeleteResponse admin().organization().groups().delete(GroupDeleteParamsparams = GroupDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/organization/groups/{group_id}

Deletes a group from the organization.

ParametersExpand Collapse
GroupDeleteParams params
Optional<String> groupId
ReturnsExpand Collapse
class GroupDeleteResponse:

Confirmation payload returned after deleting a group.

String id

Identifier of the deleted group.

boolean deleted

Whether the group was deleted.

JsonValue; object_ "group.deleted"constant"group.deleted"constant

Always group.deleted.

Delete group

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.admin.organization.groups.GroupDeleteParams;
import com.openai.models.admin.organization.groups.GroupDeleteResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        GroupDeleteResponse group = client.admin().organization().groups().delete("group_id");
    }
}
{
    "object": "group.deleted",
    "id": "group_01J1F8ABCDXYZ",
    "deleted": true
}
Returns Examples
{
    "object": "group.deleted",
    "id": "group_01J1F8ABCDXYZ",
    "deleted": true
}