Skip to main content
Docs

revokeOrganizationInvitation()

Revokes an OrganizationInvitation from a user for the specified organization.

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

RevokeOrganizationInvitationParams

  • Name
    organizationId
    Type
    string
    Description

    The ID of the organization the user was invited to.

  • Name
    invitationId
    Type
    string
    Description

    The ID of the invitation to be revoked.

  • Name
    requestingUserId
    Type
    string
    Description

    The ID of the user revoking the organization invitation.

Example

Note

Importing clerkClient varies based on your framework. Refer to the JS Backend SDK 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?
GitHubEdit on GitHub

Last updated on