> 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/panel-api/resources/dealer/settings/image.md). # Branding Customization API calls for interaction with images that used for branding of the panel. The Navixy platform can be branded through the Admin Panel by customizing various elements to reflect your company's identity. You can upload your company's logo and favicon to be displayed on the platform, wallpaper and logos in documents such as PDF and Excel reports. ## API actions API path: `panel/dealer/settings/image`. *** *required permissions*: `service_settings: "update"`. {% hint style="info" %} This is the only Admin Panel operation that uses `multipart/form-data`. Send `type` as a form part: supplying it as a query parameter fails with error code 234. The session credential still travels in the `Authorization` header, exactly as on the JSON operations. {% endhint %} ## Upload branding image > Upload a branding image of the given type. Unlike every other Admin Panel operation, this one requires a \`multipart/form-data\` request, with the image supplied as a part named \`file\`. Branding must be enabled for the dealer's plan.\ > \ > \`type\` must be sent as a form part. Supplying it as a query parameter instead fails with error code 234.\ > \ > The session credential travels in the \`Authorization\` header here exactly as it does on the JSON operations.\ > \ > If \`redirect\_target\` is supplied, the API answers \`302\` with a \`Location\` of \`\?response=\\` instead of returning the JSON body directly. ```json {"openapi":"3.1.0","info":{"title":"Navixy Admin Panel API","version":"1.2.0"},"tags":[{"name":"Dealer","description":"Operations for reading dealer information, managing activation codes, changing the dealer password, and reading or updating panel settings covering service configuration, notification originators, and branding images. All resources under the /panel/dealer/ 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":"Enter the panel session hash with the \"NVX \" prefix, e.g. \"NVX fa7bf873fab9333144e171372a321b06\". Obtain the hash from the accountAuth operation.","name":"Authorization","in":"header"}},"schemas":{"BrandingImageType":{"type":"string","description":"Branding image slot. `app_logo` requires the `branding_mobile` dealer feature; every other slot requires `branding_web`. Requesting a slot whose feature is disabled fails with error code 236.","enum":["logo","favicon","login_wallpaper","desktop_wallpaper","monitoring_logo","document_logo","app_logo"]}},"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 a 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.","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":{"/panel/dealer/settings/image/upload":{"post":{"tags":["Dealer"],"summary":"Upload branding image","description":"Upload a branding image of the given type. Unlike every other Admin Panel operation, this one requires a `multipart/form-data` request, with the image supplied as a part named `file`. Branding must be enabled for the dealer's plan.\n\n`type` must be sent as a form part. Supplying it as a query parameter instead fails with error code 234.\n\nThe session credential travels in the `Authorization` header here exactly as it does on the JSON operations.\n\nIf `redirect_target` is supplied, the API answers `302` with a `Location` of `?response=` instead of returning the JSON body directly.","operationId":"dealerSettingsImageUpload","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["type","file"],"properties":{"type":{"$ref":"#/components/schemas/BrandingImageType"},"file":{"type":"string","format":"binary","description":"The image file. Its MIME type must be one of `image/jpeg`, `image/pjpeg`, `image/png`, `image/gif`, `image/webp`, or `image/x-icon`. Use `image/x-icon` for the favicon type."},"redirect_target":{"type":"string","description":"Optional URL to redirect to instead of returning the JSON response body.","format":"uri"}}}}}},"responses":{"200":{"$ref":"#/components/responses/OK"},"302":{"description":"Returned instead of `200` when `redirect_target` is supplied. The `Location` header is `?response=`."},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array.","$ref":"#/components/responses/ResponseError"},"402":{"description":"Feature unavailable, error code 236: branding is disabled by the dealer plan","$ref":"#/components/responses/ResponseError"},"403":{"description":"Operation not permitted, error code 13: the session lacks the required permission.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}} ``` Uploaded files are stored under `static/paas//_.png` and the resulting path is returned by [settings/service/read](/docs/navixy-api/panel-api/resources/dealer/settings/service.md#post-panel-dealer-settings-service-read). #### Errors * 201 - Not found in the database - when there are no settings for dealer in the db. * 233 - No data file - if `file` part not passed. * 234 - Invalid data format - if passed `file` with unexpected `mime` type, or if `type` was not sent as a form part. * 236 - Feature unavailable due to tariff restrictions - if branding feature disabled for this dealer. * 254 - Cannot save file - on some file system errors. *** *required permissions*: `service_settings: "update"`. ## Delete branding image > Delete the branding image of the given type. The dealer's interface falls back to the platform default for that element. ```json {"openapi":"3.1.0","info":{"title":"Navixy Admin Panel API","version":"1.2.0"},"tags":[{"name":"Dealer","description":"Operations for reading dealer information, managing activation codes, changing the dealer password, and reading or updating panel settings covering service configuration, notification originators, and branding images. All resources under the /panel/dealer/ 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":"Enter the panel session hash with the \"NVX \" prefix, e.g. \"NVX fa7bf873fab9333144e171372a321b06\". Obtain the hash from the accountAuth operation.","name":"Authorization","in":"header"}},"schemas":{"BrandingImageType":{"type":"string","description":"Branding image slot. `app_logo` requires the `branding_mobile` dealer feature; every other slot requires `branding_web`. Requesting a slot whose feature is disabled fails with error code 236.","enum":["logo","favicon","login_wallpaper","desktop_wallpaper","monitoring_logo","document_logo","app_logo"]}},"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 a 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.","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":{"/panel/dealer/settings/image/delete":{"post":{"tags":["Dealer"],"summary":"Delete branding image","description":"Delete the branding image of the given type. The dealer's interface falls back to the platform default for that element.","operationId":"dealerSettingsImageDelete","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/BrandingImageType"}}}}}},"responses":{"200":{"$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.","$ref":"#/components/responses/ResponseError"},"403":{"description":"Operation not permitted, error code 13: the session lacks the required permission.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}} ``` The image reverts to the platform default for that element. #### Errors * 201 - Not found in the database - when there are no settings for a dealer in the db. --- # 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/panel-api/resources/dealer/settings/image.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.