> 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/commons/tag/tag_avatar.md). # Tag avatar The icon shown for a tag, uploaded as an image or assigned from the built-in set. A tag's avatar is the icon the interface shows for it. There are two ways to set one, and this page has an operation for each: assign one of the Navixy platform's built-in icons, or upload an image of your own. An uploaded avatar is served from `[api_base_url]/[api_static_path]/tag/avatars/`, for example `https://api.eu.navixy.com/v2/static/tag/avatars/abcdef123456789.png`. The upload returns `avatar_file_name`, which [`tag/list`](/docs/navixy-api/user-api/resources/commons/tag.md#post-tag-list) also returns. The upload is a multipart request rather than JSON, with the image in a part named `file`, and its MIME type must be one of `image/jpeg`, `image/pjpeg`, `image/png`, `image/gif`, or `image/webp`. ## API actions API base path: `/tag/avatar`. Every operation on this page requires the `tag_update` sub-user right. *** ## Assign tag icon > Assign an icon from the standard icon set to a tag.\ > \ > Set \`icon\_id\` to null to use an uploaded avatar instead of an icon.\ > \ > Also accepts GET with the same parameters as query-string values.\ > \ > Requires the \`tag\_update\` right. ```json {"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Tags","description":"Labels applied across places, tasks, employees, vehicles, geofences and trackers, and the search that finds records by them. All resources under the /tag/ 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":{"OK":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true}}}}}},"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":{"/tag/avatar/assign":{"post":{"tags":["Tags"],"summary":"Assign tag icon","description":"Assign an icon from the standard icon set to a tag.\n\nSet `icon_id` to null to use an uploaded avatar instead of an icon.\n\nAlso accepts GET with the same parameters as query-string values.\n\nRequires the `tag_update` right.","operationId":"tagAvatarAssign","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tag_id":{"type":"integer","description":"ID of the tag.","minimum":1},"icon_id":{"type":["integer","null"],"description":"Icon to assign. Null means use the uploaded avatar instead of an icon."}},"required":["tag_id"]}}}},"responses":{"200":{"description":"Icon assigned","$ref":"#/components/responses/OK"},"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"},"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 - Not found in the database, when no tag has the given `tag_id`. *** ## Upload tag avatar > Upload an avatar image for a tag.\ > \ > \*\*This is a multipart request\*\*, not JSON: \`multipart/form-data\` with the image in a part named \`file\`. The file MIME type must be one of \`image/jpeg\`, \`image/pjpeg\`, \`image/png\`, \`image/gif\`, or \`image/webp\`.\ > \ > The uploaded image becomes available at \`\/\/tag/avatars/\\`, and the returned name is also what \`tag/list\` reports as \`avatar\_file\_name\`.\ > \ > If \`redirect\_target\` is passed, the response is a redirect to that URL with \`response=\\` appended.\ > \ > Requires the \`tag\_update\` right. ```json {"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Tags","description":"Labels applied across places, tasks, employees, vehicles, geofences and trackers, and the search that finds records by them. All resources under the /tag/ 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":{"/tag/avatar/upload":{"post":{"tags":["Tags"],"summary":"Upload tag avatar","description":"Upload an avatar image for a tag.\n\n**This is a multipart request**, not JSON: `multipart/form-data` with the image in a part named `file`. The file MIME type must be one of `image/jpeg`, `image/pjpeg`, `image/png`, `image/gif`, or `image/webp`.\n\nThe uploaded image becomes available at `//tag/avatars/`, and the returned name is also what `tag/list` reports as `avatar_file_name`.\n\nIf `redirect_target` is passed, the response is a redirect to that URL with `response=` appended.\n\nRequires the `tag_update` right.","operationId":"tagAvatarUpload","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"tag_id":{"type":"integer","description":"ID of the tag."},"file":{"type":"string","description":"The image file.","format":"binary"},"redirect_target":{"type":"string","description":"Optional. URL to redirect to after the upload."}},"required":["tag_id","file"]}}}},"responses":{"200":{"description":"The stored avatar","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true},"value":{"type":"string","description":"Avatar file name."}}}}}},"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"},"402":{"description":"Error 233: the `file` part is missing. Error 234: the file has an unexpected 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 - Not found in the database, when no tag has the given `tag_id`. * 233 - No data file, when the `file` part is missing. * 234 - Invalid data format, when the `file` part has an unexpected MIME type. * 254 - Cannot save file, on a file system error. --- # 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/commons/tag/tag_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.