Skip to main content
Docs
Dashboard

updateUserProfileImage()

Updates a user's profile image. Returns a User object.

function updateUserProfileImage(userId: string, params: { file: Blob | File }): Promise<User>

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.

Warning

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

const userId = 'user_123'
const fileBits = ['profile-pic-content']
const fileName = 'profile-pic.png'
const file = new File(fileBits, fileName, { type: 'image/png' })

const params = {
  file,
}

const response = await clerkClient.users.updateUserProfileImage(userId, params)

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?
Edit this page on GitHub

Last updated on