Box Developer Documentation
Log in

A beta version of the new Box developer documentation site is launching soon! Updated Developer Guides, modern API Reference, and AI-powered search are on the way to help you build with Box faster. Stay tuned for more updates.

Latest version

Delete user avatar

delete
https://api.box.com/2.0
/users/:user_id/avatar

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

Removes an existing user avatar. You cannot reverse this operation.

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
12345

The ID of the user.

Response

none

no_content: Removes the avatar and returns an empty response.

application/jsonClient error

forbidden: Returned if the user does not have necessary permissions or is not activated.

application/jsonClient error

not_found: Returned if the user or user avatar does not exist or cannot be found.

application/jsonClient error

An unexpected client error.

delete
Delete user avatar
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

Learn more about Box SDK versioning strategy.


cURL
curl -i -X DELETE -L "https://api.box.net/2.0/users/12345/avatar" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
Node/TypeScript v10
await client.avatars.deleteUserAvatar(user.id);
Python v10
client.avatars.delete_user_avatar(user.id)
.NET v10
await client.Avatars.DeleteUserAvatarAsync(userId: user.Id);
Swift v10
try await client.avatars.deleteUserAvatar(userId: user.id)
Java v10
client.getAvatars().deleteUserAvatar(user.getId())
Java v5
String userID = "33333";
BoxUser user = new BoxUser(api, userID);
user.deleteAvatar();
Python v4
client.user('33333').delete_avatar()
.NET v6
bool isDeleted = await client.UsersManager.DeleteUserAvatarAsync(userId);
Node v4
client.users.deleteAvatar('22222', () => {
    console.log('User avatar deleted!'); 
});