Skip to content

Tag avatar

Contains API calls to interact with tag avatars.

API actions

API path: /tag/avatar.


Assigns icon_id (from standard icon set) to specified tag.

required sub-user rights: tag_update.


name description type
tag_id ID of the tag to assign. int
icon_id Icon to assign to tag. Can be null – this means that uploaded avatar should be used instead of icon. int


curl -X POST '' \
    -H 'Content-Type: application/json' \
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "tag_id": 1, "icon_id": 14}'


    "success": true


  • 201 – Not found in the database - when vehicle with specified tag_id not found.


Uploads avatar image for specified tag.
Then it will be available from [api_base_url]/[api_static_path]/tag/avatars/<file_name>

required sub-user rights: tag_update.

avatar_file_name returned in response and will be returned from /tag/list.

MUST be a POST multipart request (multipart/form-data), with one of the parts being an image file upload (with the name file).

File part mime type must be one of:

  • image/jpeg
  • image/pjpeg
  • image/png
  • image/gif
  • image/webp


name description
tag_id ID of the tag to upload.
file Image file.
redirect_target Optional. URL to redirect. If redirect_target passed return redirect to <redirect_target>?response=<urlencoded response json>


    "success": true,
    "value": "avatar.jpg"
  • value - string. Avatar file name.


  • 201 – Not found in the database - when tag with specified tag_id not found.
  • 233 – No data file - if file part not passed.
  • 234 – Invalid data format - if passed file with unexpected mime type.
  • 254 – Cannot save file - on some file system errors.

Last update: December 26, 2022