Skip to main content
Docs

unbanUser()

Removes the ban mark from the given User.

function unbanUser(userId: string): Promise<User>

Parameters

  • Name
    userId
    Type
    string
    Description

    The ID of the user to unban.

Example

Note

Importing clerkClient varies based on your framework. Refer to the Backend SDK overview for usage details, including guidance on how to access the userId and other properties.

const userId = 'user_123'

const response = await clerkClient.users.unbanUser(userId)

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint POST/users/{user_id}/unban. See the BAPI reference for more information.

Feedback

What did you think of this content?
Edit this page on GitHub

Last updated on