Skip to main content
Docs

revokeInvitation()

Revokes an .

Revoking an invitation makes the invitation email link unusable. However, it doesn't prevent the user from signing up if they follow the sign up flow.

Only active (i.e. non-revoked) invitations can be revoked.

function revokeInvitation(invitationId: string): Promise<Invitation>
  • Name
    invitationId
    Type
    string
    Description

    The ID of the invitation to revoke.

Note

Importing clerkClient varies based on your framework. Refer to the for usage details, including guidance on .

const invitationId = 'inv_123'

const response = await clerkClient.invitations.revokeInvitation(invitationId)

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint POST/invitations/{invitation_id}/revoke. See the BAPI reference for more information.

Feedback

What did you think of this content?

Last updated on