Skip to main content

revokeOrganizationInvitation()

Revokes an invitation from a user for the given Organization.

Returns the revoked OrganizationInvitation.

function revokeOrganizationInvitation(params: RevokeOrganizationInvitationParams): Promise<OrganizationInvitation>

RevokeOrganizationInvitationParams

  • Name
    invitationId
    Type
    string
    Description

    The ID of the Organization invitation to revoke.

  • Name
    organizationId
    Type
    string
    Description

    The ID of the Organization to revoke the invitation from.

  • Name
    requestingUserId?
    Type
    string
    Description

    The ID of the user revoking the invitation.

Usage

Note

Using clerkClient varies based on the SDK you're using. Refer to the overview for usage details, including guidance on how to access the userId and other properties.

const organizationId = 'org_123'
const invitationId = 'orginv_123'
const requestingUserId = 'user_123'

const response = await clerkClient.organizations.revokeOrganizationInvitation({
  organizationId,
  invitationId,
  requestingUserId,
})

Backend API (BAPI) endpoint

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

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub