Reset Avatar
- Print
- DarkLight
- PDF
Reset Avatar
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/api/v1/users.resetAvatar
Permissions required, if the setting AllowUserAvatarChange is enabled:
edit-other-user-avatarmanage-moderation-actions
Changelog
| Version | Description |
|---|---|
| 0.55.0 | Added |
Header parameters
X-User-Id
stringRequired
The authenticated user ID.
ExamplerbAXPnMktTFbNpwtJ
X-Auth-Token
stringRequired
The authenticated user token.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
Body parameters
Example 1
{
"userId": "BsNr28znDkG8aeo7W"
}object
userId
string Required
The user ID. Alternatively, you can enter the username parameter.
ExampleBsNr28znDkG8aeo7W
Responses
200
OK
Success
{
"success": true
}object
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "The required \"userId\" or \"username\" param was not provided [error-user-param-not-provided]",
"errorType": "error-user-param-not-provided"
}Example 2
{
"success": false,
"error": "Reset avatar is not allowed [error-not-allowed]",
"errorType": "error-not-allowed",
"details": {
"method": "users.resetAvatar"
}
}object
success
boolean
error
string
errorType
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
Was this article helpful?