Download Pending Avatars

It requires the run-import permission.

URLRequires AuthHTTP Method

/api/v1/downloadPendingAvatars

yes

POST

Headers

ArgumentExampleRequiredDescription

X-User-Id

myuser-name

Required

The authenticated user ID.

X-Auth-Token

myauth-token

Required

Auth token.

Example Call

curl -L -X POST 'http://localhost:3000/api/v1/downloadPendingAvatars' \
-H 'X-User-Id: d26x6zSkaPSe5gCyy' \
-H 'X-Auth-Token: Zu-Z6eKzIIz7MCCRGeHi29bYkXZCJ4SxFC0JAasqm92'

Example Result

Success

{
    "success": true,
    "count": 0
}

Error

Any of the following errors can occur on the endpoint.

  • Authorization: Requires an authentication token for the request to be made.

  • No Permission: This occurs when the authenticated user doesn't have the run-import permission.

{
    "success": false,
    "error": "unauthorized"
}

Change Log

VersionDescription

3.0.0

Added

Last updated

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