Set Avatar - Rocket.Chat Developer

Website Community User Documentation Free Trial

Search…

Rocket.Chat Developer

Quick Start

Choosing a Deployment Host

Setting up your Development Environment

Rocket.Chat

Rocket Chat Environment Setup

Repository Structure

Two Factor Authentication

Embedded Layout

White Labelling Rocket.Chat

Iframe Integration

Contribute to Rocket.Chat

Mobile App

Mobile App Environment Setup

Testing your Mobile App

Mobile App White Labelling

Mobile App FAQs

Desktop App

Desktop App Environment Setup

Developing your Desktop App

Debugging your Desktop App

Desktop App White Labelling

Omnichannel

Omnichannel Environment Setup

Developing Omnichannel Apps

Livechat Widget Development and Customization

Apps Engine

Rocket.Chat App

Rocket.Chat Apps Engine

Omnichannel FAQs

Getting Started

Adding Features

Testing your App

Sample App Snippets

Slack Compatibility

App Submission to the Marketplace

Apps-Engine API Reference

Bots

Bots Development Environment Setup

Bots Architecture

Creating Your Own Bot From Scratch

Reference

Database Schema

Schema Definition

Schema Definition v2 (Draft)

Assets Endpoints

Auto Translate Endpoints

Banners Endpoints

Channels Endpoints

Cloud Endpoints

Commands Endpoints

Custom Sounds Endpoints

Custom User Status Endpoints

Email Inbox Endpoints

Custom Emoji Endpoints

Groups Endpoints

Import Endpoints

Instances Endpoints

Integration Endpoints

Invite Endpoints

Miscellaneous Endpoints

OAuthApps Endpoints

Permissions Endpoints

Push Token Endpoints

Roles Endpoints

Rooms Endpoints

Settings Endpoints

Stats Endpoints

Subscriptions Endpoints

Teams Endpoints

Video Conference Endpoints

Webdav Endpoint

Other Important Endpoints

Livechat Widget API

Fuselage

Powered By GitBook

Set Avatar

URL
Requires Auth
HTTP Method
/api/v1/users.setAvatar
yes
POST
Uploading a File
Arguments
Argument
Example
Required
Description
image
Any image file
Required
The image file to use as the new avatar, as form data.
userId or username
BsNr28znDkG8aeo7W
Optional
The id or username of the user. If not provided, the auth user is updated.
Example Call
1
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
2
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
3
     -F "[email protected]" \
4
     http://localhost:3000/api/v1/users.setAvatar
Copied!
Example Result
1
{
2
    "success": true
3
}
Copied!
Providing a URL
Arguments
Argument
Example
Required
Description
avatarUrl
http://domain.tld/to/my/own/avatar.jpg
Required
URL of the new avatar for the user.
userId or username
BsNr28znDkG8aeo7W
Optional
The id or username of the user. If not provided, the auth user is updated.
Example Call
1
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
2
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
3
     -H "Content-type:application/json" \
4
     -d '{"avatarUrl": "http://domain.tld/to/my/own/avatar.jpg"}' \
5
     http://localhost:3000/api/v1/users.setAvatar
Copied!
Example Result
1
{
2
    "success": true
3
}
Copied!
Change Log
Version
Description
0.56.0
Add support for username argument.
0.48.0
Set other users avatars if the callee has permission.
0.46.0
Added

Last modified 1yr ago

Export as PDF

Copy link

Edit on GitHub

Contents

Uploading a File

Providing a URL