Skip to main content
Docs

deleteUserProfileImage()

Deletes a user's profile image. Returns a object.

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

Note

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

Warning

Using Backend SDK methods can contribute towards rate limiting. To remove a user's profile image, it's recommended to use the frontend method instead.

const userId = 'user_123'

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

Backend API (BAPI) endpoint

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

Feedback

What did you think of this content?

Last updated on