Skip to content
Primary navigation

Delete invite

admin.organization.invites.delete(strinvite_id) -> InviteDeleteResponse
DELETE/organization/invites/{invite_id}

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

ParametersExpand Collapse
invite_id: str
ReturnsExpand Collapse
class InviteDeleteResponse:
id: str
deleted: bool
object: Literal["organization.invite.deleted"]

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

Delete invite

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
)
invite = client.admin.organization.invites.delete(
    "invite_id",
)
print(invite.id)
{
    "object": "organization.invite.deleted",
    "id": "invite-abc",
    "deleted": true
}
Returns Examples
{
    "object": "organization.invite.deleted",
    "id": "invite-abc",
    "deleted": true
}