Skip to main content
Docs

unbanUser()

Removes the ban mark from the given .

function unbanUser(userId: string): Promise<User>
  • Name
    userId
    Type
    string
    Description

    The ID of the user to unban.

Note

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

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?

Last updated on