Set Asset

Sets an asset by name.

Requires manage-assets permission.

URLRequires AuthHTTP Method

/api/v1/assets.setAsset

yes

POST

Payload

ArgumentExampleRequiredDescription

asset

mylogo.png

Required

Asset File to upload.

assetName

logo

Required

Type of asset to upload, see examples below.

refreshAllClients

true

Optional

If needs refresh all clients to apply changes immediately.

assetName can be one of these: [logo, background, favicon_ico, favicon, favicon_16, favicon_32, favicon_192, favicon_512, touchicon_180, touchicon_180_pre, tile_70, tile_144, tile_150, tile_310_square, tile_310_wide, safari_pinned ]

Upload a file

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     -F "asset=@mylogo.png" \
     -F "assetName=logo" \
     -F "refreshAllClients=true" \     
     http://localhost:3000/api/v1/assets.setAsset

Example Result

{
    "success": true
}

Change Log

VersionDescription

0.69.0

Added

Last updated

Rocket.Chat versions receive support for six months after release.