Skip to Content
Clerk logo

Clerk Docs

Ctrl + K
Go to clerk.com

revokeInvitation()

revokeInvitation()

Revokes the invitation with the provided invitationId. Throws an error if invitationId is invalid.

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.

const invitationId = 'inv_some-id'; const invitation = await clerkClient.invitations.revokeInvitation(invitationId);

Required parameters

NameTypeDescription
invitationIdstringThe ID of the invitation to revoke.

Last updated on August 16, 2023

What did you think of this content?

Clerk © 2024