> For the complete documentation index, see [llms.txt](https://navixy.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/avatar.md). # Avatar Upload the image shown for a tracker in the interface. A tracker's avatar is the image the interface shows for it in lists and on the map. This operation uploads one, replacing whatever the tracker had before. The upload is a multipart request rather than JSON, and the accepted image formats are `image/jpeg`, `image/pjpeg`, `image/png`, `image/gif`, and `image/webp`. ## API actions API base path: `/tracker/avatar`. *** *Required sub-user rights:* `tracker_update`. ## Upload a tracker avatar > Upload an avatar image for a tracker. \*\*Multipart request\*\*, with the image in a part named \`file\`.\ > \ > Accepted MIME types are \`image/jpeg\`, \`image/pjpeg\`, \`image/png\`, \`image/gif\` and \`image/webp\`. Once uploaded the image is served from \`/\[api\_static\_path]/tracker/avatars/\\`, for example \` > \ > Requires the \`tracker\_update\` right. ```json {"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Trackers","description":"Trackers, the devices the platform tracks, together with the geo links that share their live location with people outside the account. Resources under the /tracker/ path."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"responses":{"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/tracker/avatar/upload":{"post":{"tags":["Trackers"],"summary":"Upload a tracker avatar","description":"Upload an avatar image for a tracker. **Multipart request**, with the image in a part named `file`.\n\nAccepted MIME types are `image/jpeg`, `image/pjpeg`, `image/png`, `image/gif` and `image/webp`. Once uploaded the image is served from `/[api_static_path]/tracker/avatars/`, for example `https://api.eu.navixy.com/v2/static/tracker/avatars/abcdef123456789.png`.\n\nRequires the `tracker_update` right.","operationId":"trackerAvatarUpload","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"tracker_id":{"type":"integer","description":"ID of the tracker, also known as the object ID. Must belong to the current account and not be blocked."},"file":{"type":"string","description":"The image file.","format":"binary"},"redirect_target":{"type":"string","description":"Optional. URL to redirect to. When given, the response is a redirect to `?response=` instead of a JSON body."}},"required":["tracker_id","file"]}}}},"responses":{"200":{"description":"The uploaded avatar","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true},"value":{"type":"string","description":"File name of the stored avatar."}}}}}},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"403":{"description":"Error 201: no tracker with this ID belongs to the account. Error 208: the tracker exists but is blocked, normally because its tariff ended. Error 233: no file part was sent. Error 234: the file has an unaccepted MIME type. Error 254: the file could not be saved.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}} ``` #### Errors These errors come in addition to the [general error codes](/docs/navixy-api/general/errors.md#error-codes): * 201 - No tracker with this ID belongs to the account. * 208 - The tracker exists but is blocked, normally because its tariff ended. * 233 - No file part was sent. * 234 - The file has an unaccepted MIME type. * 254 - The file could not be saved. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/avatar.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.