Add generic avatar using PUT

PUT

/avatar

Last modified:2026-09-28 22:49:58

OperationId:AddAvatarSharedGenericUse

Adds an image, the same as POST /avatar, to the generic avatar library that GET /avatar lists. Every call adds a new image; none is replaced.

Requires Super User. Any other scope gets 403.

Send the image as multipart/form-data in a part named file. JPEG, PNG, GIF, and WebP are accepted, recognized from the file's content rather than its name or content type; a GIF keeps its first frame only. The image must be square, at most 20 MB, and at most 8,000 pixels on a side; the size is checked before the image is decoded. It is re-encoded as WebP, which drops embedded metadata, in two sizes: at most 256 by 256 pixels and 100 KB, and at most 48 by 48 pixels and 20 KB. A smaller image is not enlarged. file-modified-for-limits: yes means the image had to be scaled down or compressed further to fit. The request body is the image itself, so this page shows no request example.

The answer comes back as soon as the image is published over the service bus (SBUS), and the image is stored shortly after. The answer shows user and domain as *. To remove one, call DELETE /avatar/{filename}.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params multipart/form-dataRequired

Responses

🟢202Accepted

application/json

The upload was published over SBUS and is applied shortly after; see the description.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🔴500Server Error

🔴503Service Unavailable

🔴507Insufficient Storage

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://awqacore01.crexendocloud.com/ns-api/v2/avatar' \
--header 'Authorization: Bearer <token>' \
--form 'file=@""'

Response Example

202 - Generic avatar added

{
    "filename": "0e4a6c8b2d1f3a5c7e9b0d2f4a6c8e1b.webp",
    "user": "*",
    "domain": "*",
    "path": "/ns-api/v2/avatar/0e4a6c8b2d1f3a5c7e9b0d2f4a6c8e1b.webp",
    "filetype": "image/webp",
    "filesize-large-bytes": 7852,
    "filesize-small-bytes": 1026,
    "path-large": "/ns-api/v2/avatar/256/0e4a6c8b2d1f3a5c7e9b0d2f4a6c8e1b.webp",
    "path-small": "/ns-api/v2/avatar/48/0e4a6c8b2d1f3a5c7e9b0d2f4a6c8e1b.webp",
    "file-modified-for-limits": "no"
}

Modified at 2026-09-28 22:49:58

List generic avatars

Add generic avatar