Skip to main content
Docs

deleteUser()

Deletes a User given a valid ID.

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

Parameters

  • Name
    userId
    Type
    string
    Description

    The ID of the user to delete.

Usage

Note

Using 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 userId = 'user_123'

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

Example

app/api/example/route.ts
import { clerkClient } from '@clerk/nextjs/server'
import { NextResponse } from 'next/server'

export async function POST() {
  await clerkClient.users.deleteUser('user_123')

  return NextResponse.json({ success: true })
}
src/api/example.ts
import type { APIRoute } from 'astro'
import { clerkClient } from '@clerk/astro/server'

export const POST: APIRoute = async (context) => {
  await clerkClient(context).users.deleteUser('user_123')

  return new Response(JSON.stringify({ success: true }), { status: 200 })
}
public.ts
import { clerkClient } from '@clerk/express'

app.post('/deleteUser', async (req, res) => {
  await clerkClient.users.deleteUser('user_123')

  res.status(200).json({ success: true })
})
app/routes/example.tsx
import { clerkClient } from '@clerk/react-router/server'
import type { Route } from './+types/example'
import { json, redirect } from 'react-router-dom'

export async function action({ request }: Route.ActionArgs) {
  const formData = await request.formData()
  const userId = formData.get('userId')

  await clerkClient.users.deleteUser(userId)

  return json({ success: true })
}
app/routes/api/example.tsx
import { json } from '@tanstack/react-start'
import { createFileRoute } from '@tanstack/react-router'
import { auth, clerkClient } from '@clerk/tanstack-react-start/server'

export const ServerRoute = createFileRoute('/api/example')({
  server: {
    handlers: {
      POST: async () => {
        await clerkClient().users.deleteUser('user_123')

        return json({ success: true })
      },
    },
  },
})

Backend API (BAPI) endpoint

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

Here's an example of making a request directly to the endpoint using cURL.

terminal
  curl 'https://api.clerk.com/v1/users/{user_id}' -X DELETE -H 'Authorization:Bearer YOUR_SECRET_KEY' -H 'Content-Type:application/json'

Feedback

What did you think of this content?
GitHubEdit on GitHub

Last updated on