> 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/settings.md).

# Settings

A tracker's display label and the group it belongs to.

These two operations cover the tracker's own presentation: the label shown for it in the interface, and the [group](/docs/navixy-api/user-api/resources/tracking/tracker/group.md) it sits in.

Everything else under settings is about the device rather than the record: [tracking mode](/docs/navixy-api/user-api/resources/tracking/tracker/settings/tracking.md), [parking detection](/docs/navixy-api/user-api/resources/tracking/tracker/settings/trip_detection.md), [LBS](/docs/navixy-api/user-api/resources/tracking/tracker/settings/lbs.md), and the model-specific [special settings](/docs/navixy-api/user-api/resources/tracking/tracker/settings/special.md).

## API actions

API base path: `/tracker/settings`.

***

## Read label and group

> Get the tracker's label and group. Available to demo accounts.

```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"}},"schemas":{"TrackerBaseSettings":{"type":"object","description":"A tracker's label and group.","properties":{"label":{"type":"string","description":"User-defined label for the tracker."},"group_id":{"type":"integer","description":"Tracker group ID, `0` when the tracker is in no group."}}}},"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/settings/read":{"post":{"tags":["Trackers"],"summary":"Read label and group","description":"Get the tracker's label and group. Available to demo accounts.","operationId":"trackerSettingsRead","requestBody":{"required":true,"content":{"application/json":{"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."}},"required":["tracker_id"]}}}},"responses":{"200":{"description":"The base settings","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true},"settings":{"$ref":"#/components/schemas/TrackerBaseSettings"}}}}}},"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.","$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.

***

*Required sub-user rights:* `tracker_update`.

## Change label and group

> Change the tracker's label and group.\
> \
> \*\*Both \`label\` and \`group\_id\` are required\*\*, so this call always writes both. Read the current values first if you mean to change only one.\
> \
> 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":{"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":{"/tracker/settings/update":{"post":{"tags":["Trackers"],"summary":"Change label and group","description":"Change the tracker's label and group.\n\n**Both `label` and `group_id` are required**, so this call always writes both. Read the current values first if you mean to change only one.\n\nRequires the `tracker_update` right.","operationId":"trackerSettingsUpdate","requestBody":{"required":true,"content":{"application/json":{"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."},"group_id":{"type":"integer","description":"Tracker group ID, or `0` for no group. The group must exist."},"label":{"type":"string","description":"User-defined label. Printable characters, 1 to 60, and it cannot contain `<` or `>`.","minLength":1,"maxLength":60}},"required":["tracker_id","group_id","label"]}}}},"responses":{"200":{"description":"The settings were changed","$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":"Error 201: no tracker with this ID belongs to the account. Error 204: no group with this ID. Error 208: the tracker exists but is blocked, normally because its tariff ended.","$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.
* 204 - No group with this ID.
* 208 - The tracker exists but is blocked, normally because its tariff ended.

## More in this section

#### LBS settings

| Endpoint                                                                                                                                | Method | What it does                |
| --------------------------------------------------------------------------------------------------------------------------------------- | ------ | --------------------------- |
| [`/tracker/settings/lbs/read`](/docs/navixy-api/user-api/resources/tracking/tracker/settings/lbs.md#post-tracker-settings-lbs-read)     | POST   | Read the LBS radius limit   |
| [`/tracker/settings/lbs/update`](/docs/navixy-api/user-api/resources/tracking/tracker/settings/lbs.md#post-tracker-settings-lbs-update) | POST   | Change the LBS radius limit |

#### Tracking mode

| Endpoint                                                                                                                                               | Method | What it does                  |
| ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------ | ----------------------------- |
| [`/tracker/settings/tracking/read`](/docs/navixy-api/user-api/resources/tracking/tracker/settings/tracking.md#post-tracker-settings-tracking-read)     | POST   | Read tracking mode settings   |
| [`/tracker/settings/tracking/update`](/docs/navixy-api/user-api/resources/tracking/tracker/settings/tracking.md#post-tracker-settings-tracking-update) | POST   | Change tracking mode settings |

#### Parking detection

| Endpoint                                                                                                                                                                 | Method | What it does                      |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------ | --------------------------------- |
| [`/tracker/settings/trip_detection/read`](/docs/navixy-api/user-api/resources/tracking/tracker/settings/trip_detection.md#post-tracker-settings-trip_detection-read)     | POST   | Read parking detection settings   |
| [`/tracker/settings/trip_detection/update`](/docs/navixy-api/user-api/resources/tracking/tracker/settings/trip_detection.md#post-tracker-settings-trip_detection-update) | POST   | Change parking detection settings |

#### Special

| Endpoint                                                                                                                                            | Method | What it does            |
| --------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ----------------------- |
| [`/tracker/settings/special/read`](/docs/navixy-api/user-api/resources/tracking/tracker/settings/special.md#post-tracker-settings-special-read)     | POST   | Read special settings   |
| [`/tracker/settings/special/update`](/docs/navixy-api/user-api/resources/tracking/tracker/settings/special.md#post-tracker-settings-special-update) | POST   | Change special settings |


---

# 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/settings.md?ask=<question>&goal=<endgoal>
```

`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.