Skip to main content

deleteUserProfileImage()

Deletes a user's profile image.

Returns the updated User.

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

Parameters

  • Name
    userId
    Type
    string
    Description

    The ID of the user to delete the profile image for.

Usage

Note

Using clerkClient varies based on the SDK you're using. Refer to the overview for usage details, including guidance on how to access the userId and other properties.

Warning

Using clerkClient methods can contribute towards rate limiting. To remove a user's profile image, it's recommended to use the frontend user.setProfileImage({ file: null }) 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 DELETE/users/{user_id}/profile_image. See the BAPI reference for more information.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub