Skip to content
Primary navigation

Delete invite

InviteDeleteResponse admin().organization().invites().delete(InviteDeleteParamsparams = InviteDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/organization/invites/{invite_id}

Delete an invite. If the invite has already been accepted, it cannot be deleted.

ParametersExpand Collapse
InviteDeleteParams params
Optional<String> inviteId
ReturnsExpand Collapse
class InviteDeleteResponse:
String id
boolean deleted
JsonValue; object_ "organization.invite.deleted"constant"organization.invite.deleted"constant

The object type, which is always organization.invite.deleted

Delete invite

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.admin.organization.invites.InviteDeleteParams;
import com.openai.models.admin.organization.invites.InviteDeleteResponse;

public final class Main {
    private Main() {}

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

        InviteDeleteResponse invite = client.admin().organization().invites().delete("invite_id");
    }
}
{
    "object": "organization.invite.deleted",
    "id": "invite-abc",
    "deleted": true
}
Returns Examples
{
    "object": "organization.invite.deleted",
    "id": "invite-abc",
    "deleted": true
}