Skip to content
Docs
Invitations
Delete

Delete

API Reference
Organizations
Invitations

Delete

client.organizations.invitations.delete(stringinvitationID, InvitationDeleteParams { organization_id, xClientRequestID } params, RequestOptionsoptions?): void
DELETE/organizations/{organization_id}/invitations/{invitation_id}

Delete an invitation

ParametersExpand Collapse
invitationID: string

Identifier for API resources. A 26-char nanoid (URL/DNS safe).

minLength1
maxLength255
params: InvitationDeleteParams { organization_id, xClientRequestID }
organization_id: string

Path param: Organization ID or label identifier

minLength1
maxLength255
xClientRequestID?: string

Header param: Unique request identifier specified by the originating caller and passed along by proxies.

formatuuid

Delete

import KeycardAPI from '@keycardai/api';

const client = new KeycardAPI();

await client.organizations.invitations.delete('ab3def8hij2klm9opq5rst7uvw', {
  organization_id: 'x',
});
Returns Examples