> 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/fleet/vehicle/avatar.md). # Vehicle avatar The icon shown for a vehicle, assigned from the built-in set or uploaded. A vehicle's avatar is the icon shown for it in the interface. As with [places](/docs/navixy-api/user-api/resources/field-service/place/avatar.md) and [employees](/docs/navixy-api/user-api/resources/field-service/employee/avatar.md), it cannot be set through `vehicle/update`: use `avatar/assign` to pick one of the built-in icons, or `avatar/upload` to supply an image. ## API actions API base path: `/vehicle/avatar`. *** *Required sub-user rights:* `vehicle_update`. `icon_id` can be null, which means the uploaded avatar should be used instead of an icon. ## Assign vehicle icon > Assign an icon to a vehicle.\ > \ > Set \`icon\_id\` to null to use an uploaded avatar instead of an icon.\ > \ > \*\*\`icon\_color\` is required\*\* as well as \`vehicle\_id\`.\ > \ > Also accepts GET with the same parameters as query-string values.\ > \ > Requires the \`vehicle\_update\` right. ```json {"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Vehicles","description":"Vehicles in the fleet, their avatars and status list, spreadsheet import, and the service works scheduled against them. All resources under the /vehicle/ 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":{"/vehicle/avatar/assign":{"post":{"tags":["Vehicles"],"summary":"Assign vehicle icon","description":"Assign an icon to a vehicle.\n\nSet `icon_id` to null to use an uploaded avatar instead of an icon.\n\n**`icon_color` is required** as well as `vehicle_id`.\n\nAlso accepts GET with the same parameters as query-string values.\n\nRequires the `vehicle_update` right.","operationId":"vehicleAvatarAssign","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"vehicle_id":{"type":"integer","description":"ID of the vehicle."},"icon_id":{"type":["integer","null"],"description":"ID of the icon. Null means use the uploaded avatar instead."},"icon_color":{"type":"string","description":"Icon colour."}},"required":["vehicle_id","icon_color"]}}}},"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. *** Uploads avatar image for specified vehicle.Then it will be available from `[api_base_url]//vehicle/avatars/`e.g. `https://api.eu.navixy.com/v2/static/vehicle/avatars/abcdef123456789.png`. **avatar\_file\_name** returned in response and will be returned from [/vehicle/list](/docs/navixy-api/user-api/resources/fleet/vehicle.md#post-vehicle-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` If `redirect_target` passed a return redirect to `response=`. *Required sub-user rights:* `vehicle_update`. ## Upload vehicle avatar > Upload an avatar image for a vehicle.\ > \ > \*\*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 \`\/\/vehicle/avatars/\\`, and the returned name is also what \`vehicle/list\` reports as \`avatar\_file\_name\`.\ > \ > If \`redirect\_target\` is passed, the response is a redirect to that URL with \`response=\\` appended.\ > \ > Requires the \`vehicle\_update\` right. ```json {"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Vehicles","description":"Vehicles in the fleet, their avatars and status list, spreadsheet import, and the service works scheduled against them. All resources under the /vehicle/ 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":{"/vehicle/avatar/upload":{"post":{"tags":["Vehicles"],"summary":"Upload vehicle avatar","description":"Upload an avatar image for a vehicle.\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 `//vehicle/avatars/`, and the returned name is also what `vehicle/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 `vehicle_update` right.","operationId":"vehicleAvatarUpload","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"vehicle_id":{"type":"integer","description":"Vehicle ID."},"file":{"type":"string","description":"The image file.","format":"binary"},"redirect_target":{"type":"string","description":"Optional. URL to redirect to after upload."}},"required":["vehicle_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 234: the file exceeds the size limit. Error 233: the file could not be processed.","$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, 233, 234, 254. --- # 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/fleet/vehicle/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.