> 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/user/settings.md). # Settings An account's own preferences for timezone, formats, balance alerts, and file storage. User settings are the account's own preferences: the timezone and formats everything else is rendered in, when to warn about a low balance, and how uploaded files are handled. Two of these are stored separately from the rest and are visible only to a master user, which is worth knowing before reading the response. `balance_alert_settings` and `file_storage_settings`, along with `first_user_balance_warning_period` and `second_user_balance_warning_period`, are **absent entirely** unless the caller holds the `admin` right, rather than merely being read-only. The rest of the `settings` object is filtered by the dealer's GIS package before it is returned, so a field can be absent or null on a platform with a restricted package. ## Settings object ## The UserSettings object ```json {"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"components":{"schemas":{"UserSettings":{"type":"object","description":"A user's locale, display, and provider preferences. Filtered by the dealer's GIS package before being returned, so a field may be absent on a restricted package.","properties":{"locale":{"type":"string","description":"Locale code, for example `en`."},"time_zone":{"type":"string","description":"ISO timezone ID, for example `Europe/Budapest`."},"date_format":{"type":["string","null"],"description":"Optional. Date representation: `ddMMyyyy_dots` is 01.12.2021, `ddMMyyyy_slashes` is 01/12/2021, `MMddyyyy_hyphens` is 12-01-2021, `yyyyMMdd_hyphens` is 2021-12-01, `dMMMy` is 1 Dec 2021, `dMMMMy` is 1 December 2021.","enum":["ddMMyyyy_dots","ddMMyyyy_slashes","MMddyyyy_hyphens","yyyyMMdd_hyphens","dMMMy","dMMMMy"]},"hour_mode":{"type":["string","null"],"description":"Optional. Time representation: `TWENTY_FOUR_HOURS` is a 24-hour clock such as 17:45, `TWELVE_HOURS` is a 12-hour clock such as 5:45 PM.","enum":["TWELVE_HOURS","TWENTY_FOUR_HOURS"]},"measurement_system":{"type":"string","description":"Measurement system.","enum":["metric","imperial","us","metric_gal_us","nautical"]},"geocoder":{"type":["string","null"],"description":"Preferred geocoder type.","enum":["google","yandex","progorod","osm","locationiq"]},"route_provider":{"type":["string","null"],"description":"Preferred route finding provider.","enum":["google","progorod","osrm"]},"translit":{"type":"boolean","description":"`true` if SMS notifications are transliterated."}}}}}} ``` ## The BalanceAlertSettings object ```json {"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"components":{"schemas":{"BalanceAlertSettings":{"type":"object","description":"Where low-balance alerts are sent.","properties":{"emails":{"type":"array","description":"Email addresses that receive balance alerts.","items":{"type":"string"}}}}}}} ``` ## The FileStorageSettings object ```json {"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"components":{"schemas":{"FileStorageSettings":{"type":"object","description":"How uploaded files are handled.","properties":{"auto_overwrite":{"type":"boolean","description":"Whether uploading a file with an existing name overwrites it."}}}}}} ``` `balance_alert_settings.emails` lists the addresses that receive balance alerts, and an empty array turns those alerts off. `file_storage_settings.auto_overwrite` defaults to `false`. ## API actions API base path: `/user/settings`. Operations that list no errors of their own return only the [general error codes](/docs/navixy-api/general/errors.md#error-codes). *** *Required sub-user rights:* `admin` for the `balance_alert_settings` and `file_storage_settings` fields, available only to master users. ## Read user settings > Return the current user's settings.\ > \ > \`file\_storage\_settings\`, \`balance\_alert\_settings\`, \`first\_user\_balance\_warning\_period\`, and \`second\_user\_balance\_warning\_period\` are \*\*absent entirely\*\* unless the caller holds the \`admin\` right, rather than merely read-only.\ > \ > The \`settings\` object is filtered by the dealer's GIS package before being returned, so some fields may be absent or null on platforms with a restricted package.\ > \ > Also accepts GET with the same parameters as query-string values. ```json {"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Users","description":"Operations for authenticating a user, managing their sessions, reading and updating their settings and personal information, reading audit records, and registering custom applications. All resources under the /user/ 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"}},"schemas":{"UserSettings":{"type":"object","description":"A user's locale, display, and provider preferences. Filtered by the dealer's GIS package before being returned, so a field may be absent on a restricted package.","properties":{"locale":{"type":"string","description":"Locale code, for example `en`."},"time_zone":{"type":"string","description":"ISO timezone ID, for example `Europe/Budapest`."},"date_format":{"type":["string","null"],"description":"Optional. Date representation: `ddMMyyyy_dots` is 01.12.2021, `ddMMyyyy_slashes` is 01/12/2021, `MMddyyyy_hyphens` is 12-01-2021, `yyyyMMdd_hyphens` is 2021-12-01, `dMMMy` is 1 Dec 2021, `dMMMMy` is 1 December 2021.","enum":["ddMMyyyy_dots","ddMMyyyy_slashes","MMddyyyy_hyphens","yyyyMMdd_hyphens","dMMMy","dMMMMy"]},"hour_mode":{"type":["string","null"],"description":"Optional. Time representation: `TWENTY_FOUR_HOURS` is a 24-hour clock such as 17:45, `TWELVE_HOURS` is a 12-hour clock such as 5:45 PM.","enum":["TWELVE_HOURS","TWENTY_FOUR_HOURS"]},"measurement_system":{"type":"string","description":"Measurement system.","enum":["metric","imperial","us","metric_gal_us","nautical"]},"geocoder":{"type":["string","null"],"description":"Preferred geocoder type.","enum":["google","yandex","progorod","osm","locationiq"]},"route_provider":{"type":["string","null"],"description":"Preferred route finding provider.","enum":["google","progorod","osrm"]},"translit":{"type":"boolean","description":"`true` if SMS notifications are transliterated."}}},"FileStorageSettings":{"type":"object","description":"How uploaded files are handled.","properties":{"auto_overwrite":{"type":"boolean","description":"Whether uploading a file with an existing name overwrites it."}}},"BalanceAlertSettings":{"type":"object","description":"Where low-balance alerts are sent.","properties":{"emails":{"type":"array","description":"Email addresses that receive balance alerts.","items":{"type":"string"}}}}},"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":{"/user/settings/read":{"post":{"tags":["Users"],"summary":"Read user settings","description":"Return the current user's settings.\n\n`file_storage_settings`, `balance_alert_settings`, `first_user_balance_warning_period`, and `second_user_balance_warning_period` are **absent entirely** unless the caller holds the `admin` right, rather than merely read-only.\n\nThe `settings` object is filtered by the dealer's GIS package before being returned, so some fields may be absent or null on platforms with a restricted package.\n\nAlso accepts GET with the same parameters as query-string values.","operationId":"userSettingsRead","responses":{"200":{"description":"The user's settings","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true},"settings":{"$ref":"#/components/schemas/UserSettings"},"file_storage_settings":{"allOf":[{"$ref":"#/components/schemas/FileStorageSettings"}],"description":"Present only when the caller holds the `admin` right."},"balance_alert_settings":{"allOf":[{"$ref":"#/components/schemas/BalanceAlertSettings"}],"description":"Present only when the caller holds the `admin` right."},"first_user_balance_warning_period":{"type":"string","description":"How long before a projected zero balance the first alert is sent, as a duration such as `8d`. Present only when the caller holds the `admin` right."},"second_user_balance_warning_period":{"type":"string","description":"How long before a projected zero balance the second alert is sent, as a duration such as `2d`. Present only when the caller holds the `admin` right."}}}}}},"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"}}}}}} ``` *** {% hint style="warning" %} This operation **replaces** the stored settings rather than merging into them. Only `time_zone` is required, and every writable field left out of the request is cleared, including `date_format` and `hour_mode`. Send every field you intend to keep. `balance_alert_settings` and `file_storage_settings` are stored separately and do survive omission. {% endhint %} *Required sub-user rights:* `admin` for the `balance_alert_settings` and `file_storage_settings` fields, available only to master users. ## Update user settings > Replace the current user's settings.\ > \ > \*\*This is a full replacement, not a merge, and only \`time\_zone\` is required.\*\* Any writable field omitted from the request is cleared, including \`date\_format\` and \`hour\_mode\`.\ > \ > Send every field you intend to keep. \`file\_storage\_settings\` and \`balance\_alert\_settings\` are stored separately and do survive omission.\ > \ > Updating \`balance\_alert\_settings\` or \`file\_storage\_settings\` requires the \`admin\` right. ```json {"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Users","description":"Operations for authenticating a user, managing their sessions, reading and updating their settings and personal information, reading audit records, and registering custom applications. All resources under the /user/ 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"}},"schemas":{"BalanceAlertSettings":{"type":"object","description":"Where low-balance alerts are sent.","properties":{"emails":{"type":"array","description":"Email addresses that receive balance alerts.","items":{"type":"string"}}}},"FileStorageSettings":{"type":"object","description":"How uploaded files are handled.","properties":{"auto_overwrite":{"type":"boolean","description":"Whether uploading a file with an existing name overwrites it."}}}},"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":{"/user/settings/update":{"post":{"tags":["Users"],"summary":"Update user settings","description":"Replace the current user's settings.\n\n**This is a full replacement, not a merge, and only `time_zone` is required.** Any writable field omitted from the request is cleared, including `date_format` and `hour_mode`.\n\nSend every field you intend to keep. `file_storage_settings` and `balance_alert_settings` are stored separately and do survive omission.\n\nUpdating `balance_alert_settings` or `file_storage_settings` requires the `admin` right.","operationId":"userSettingsUpdate","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"time_zone":{"type":"string","description":"ISO timezone ID, for example `Europe/Amsterdam`."},"locale":{"type":"string","description":"Locale code, for example `en` or `nl_NL`."},"measurement_system":{"type":"string","description":"Measurement system.","enum":["metric","imperial","us","metric_gal_us","nautical"]},"date_format":{"type":["string","null"],"description":"Date representation. **Cleared if omitted**, and absent from the parameter list on older prose pages, which is how it gets wiped unnoticed.","enum":["ddMMyyyy_dots","ddMMyyyy_slashes","MMddyyyy_hyphens","yyyyMMdd_hyphens","dMMMy","dMMMMy"]},"hour_mode":{"type":["string","null"],"description":"Time representation. **Cleared if omitted**, and absent from the parameter list on older prose pages, which is how it gets wiped unnoticed.","enum":["TWELVE_HOURS","TWENTY_FOUR_HOURS"]},"geocoder":{"type":["string","null"],"description":"Preferred geocoder.","enum":["google","yandex","progorod","osm","locationiq"]},"route_provider":{"type":["string","null"],"description":"Preferred route provider.","enum":["google","progorod","osrm"]},"translit":{"type":"boolean","description":"`true` if SMS notifications should be transliterated."},"balance_alert_settings":{"allOf":[{"$ref":"#/components/schemas/BalanceAlertSettings"}],"description":"Requires the `admin` right."},"file_storage_settings":{"allOf":[{"$ref":"#/components/schemas/FileStorageSettings"}],"description":"Requires the `admin` right."}},"required":["time_zone"]}}}},"responses":{"200":{"description":"Settings updated","$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"},"403":{"description":"Operation not permitted, error code 13: the caller lacks the `admin` right needed for `balance_alert_settings` or `file_storage_settings`.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}} ``` *** {% hint style="warning" %} Send the settings fields at the **top level** of the request body, not wrapped in a `file_storage_settings` object. A wrapped body is accepted and answers `success: true`, but writes defaults instead of the values supplied. {% endhint %} *Required sub-user rights:* `admin` (available only to master users). ## Update file storage settings > Replace the current user's file storage settings. Requires the \`admin\` right.\ > \ > \*\*Send the settings fields at the top level of the request body\*\*, not wrapped in a \`file\_storage\_settings\` object. The operation deserializes the whole body into the settings object, so a wrapped body is accepted, returns \`success: true\`, and silently writes defaults instead of the values supplied.\ > \ > \*\*This is a full replacement\*\*: an omitted field is written as its default. ```json {"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Users","description":"Operations for authenticating a user, managing their sessions, reading and updating their settings and personal information, reading audit records, and registering custom applications. All resources under the /user/ 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":{"/user/settings/file_storage/update":{"post":{"tags":["Users"],"summary":"Update file storage settings","description":"Replace the current user's file storage settings. Requires the `admin` right.\n\n**Send the settings fields at the top level of the request body**, not wrapped in a `file_storage_settings` object. The operation deserializes the whole body into the settings object, so a wrapped body is accepted, returns `success: true`, and silently writes defaults instead of the values supplied.\n\n**This is a full replacement**: an omitted field is written as its default.","operationId":"userSettingsFileStorageUpdate","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"auto_overwrite":{"type":"boolean","description":"Whether uploading a file with an existing name overwrites it. Defaults to `false` when omitted."}}}}}},"responses":{"200":{"description":"File storage settings updated","$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"},"403":{"description":"Operation not permitted, error code 13: the caller lacks the `admin` right.","$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): * 13 - Operation not permitted, when the user has insufficient rights. ## More in this section #### User UI settings | Endpoint | Method | What it does | | -------------------------------------------------------------------------------------------------------------------------- | ------ | ----------------- | | [`/user/settings/ui/read`](/docs/navixy-api/user-api/resources/commons/user/settings/ui.md#post-user-settings-ui-read) | POST | Read UI setting | | [`/user/settings/ui/update`](/docs/navixy-api/user-api/resources/commons/user/settings/ui.md#post-user-settings-ui-update) | POST | Update UI setting | --- # 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 by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://navixy.com/docs/navixy-api/user-api/resources/commons/user/settings.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. 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.