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

# Notification Settings

API calls to read and update notification settings.

Notification settings in the Navixy Admin Panel are used to manage and configure alerts and notifications for various events and conditions. These settings allow you to customize notification channels, specifying how notifications are delivered, including options like email, SMS, or push notifications.

## Notification Settings Object

## The NotificationSettings object

```json
{"openapi":"3.1.0","info":{"title":"Navixy Admin Panel API","version":"1.2.0"},"components":{"schemas":{"NotificationSettings":{"type":"object","description":"Originators the platform uses when sending email, SMS, and voice notifications to a dealer's end users.","properties":{"email_from":{"type":"string","description":"Address notification email is sent from. Either a bare address or an address with a display name.","maxLength":100},"email_footer":{"type":"string","description":"Footer appended to all notification emails.","maxLength":600},"email_special":{"type":["string","null"],"description":"Optional. Address used for PaaS reports. The only field of this object that may be omitted, in which case it is cleared. Also exposed by the service settings operations, where it is the same underlying value.","maxLength":255},"sms_originator":{"type":"string","description":"Originator shown on SMS notifications. Must match the pattern `(\\p{L}|\\d|[-'\" .,:/])*`.","maxLength":20},"caller_id":{"type":"string","description":"Originator shown on voice notifications. Must match the pattern `(\\p{L}|\\d|[-'\" .,:/])*`.","maxLength":20}}}}}}
```

`email_special` is the same underlying value as `email_special` in the [service settings](/docs/navixy-api/panel-api/resources/dealer/settings/service.md#service-settings-object). Writing it through either endpoint is visible in the other.

## API actions

API path: `panel/dealer/settings/notification`.

***

*required permissions*: `notification_settings: "read"`.

## Read notification settings

> Read the current dealer's notification settings: the originators used when the platform sends email, SMS, and voice notifications to that dealer's end users. Takes no parameters beyond the session credential.

```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":{"NotificationSettings":{"type":"object","description":"Originators the platform uses when sending email, SMS, and voice notifications to a dealer's end users.","properties":{"email_from":{"type":"string","description":"Address notification email is sent from. Either a bare address or an address with a display name.","maxLength":100},"email_footer":{"type":"string","description":"Footer appended to all notification emails.","maxLength":600},"email_special":{"type":["string","null"],"description":"Optional. Address used for PaaS reports. The only field of this object that may be omitted, in which case it is cleared. Also exposed by the service settings operations, where it is the same underlying value.","maxLength":255},"sms_originator":{"type":"string","description":"Originator shown on SMS notifications. Must match the pattern `(\\p{L}|\\d|[-'\" .,:/])*`.","maxLength":20},"caller_id":{"type":"string","description":"Originator shown on voice notifications. Must match the pattern `(\\p{L}|\\d|[-'\" .,:/])*`.","maxLength":20}}}},"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 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/notification/read":{"post":{"tags":["Dealer"],"summary":"Read notification settings","description":"Read the current dealer's notification settings: the originators used when the platform sends email, SMS, and voice notifications to that dealer's end users. Takes no parameters beyond the session credential.","operationId":"dealerSettingsNotificationRead","responses":{"200":{"description":"Notification settings","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true},"value":{"$ref":"#/components/schemas/NotificationSettings"}}}}}},"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"}}}}}}
```

#### Errors

[General](/docs/navixy-api/general/errors.md#error-codes) types only.

***

*required permissions*: `notification_settings: "update"`.

{% hint style="warning" %}
This is a full replacement, not a partial update. Any writable field you omit is reset to its default rather than left alone: omitting `email_special` clears it. Read the current settings first, change what you need, and send the complete object back.
{% endhint %}

## Update notification settings

> Update the current dealer's notification settings.\
> \
> \*\*This is a full replacement, not a partial update.\*\* Any writable field you omit is reset to its default rather than left alone. Omitting the optional \`email\_special\`, for example, clears it. Always read the current settings first, change what you need, and send the complete object back.\
> \
> \`email\_from\`, \`email\_footer\`, \`sms\_originator\`, and \`caller\_id\` are mandatory on every call. Omitting any of them fails with error code 7 and an \`errors\` array naming the missing field.

```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":{"NotificationSettings":{"type":"object","description":"Originators the platform uses when sending email, SMS, and voice notifications to a dealer's end users.","properties":{"email_from":{"type":"string","description":"Address notification email is sent from. Either a bare address or an address with a display name.","maxLength":100},"email_footer":{"type":"string","description":"Footer appended to all notification emails.","maxLength":600},"email_special":{"type":["string","null"],"description":"Optional. Address used for PaaS reports. The only field of this object that may be omitted, in which case it is cleared. Also exposed by the service settings operations, where it is the same underlying value.","maxLength":255},"sms_originator":{"type":"string","description":"Originator shown on SMS notifications. Must match the pattern `(\\p{L}|\\d|[-'\" .,:/])*`.","maxLength":20},"caller_id":{"type":"string","description":"Originator shown on voice notifications. Must match the pattern `(\\p{L}|\\d|[-'\" .,:/])*`.","maxLength":20}}}},"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/notification/update":{"post":{"tags":["Dealer"],"summary":"Update notification settings","description":"Update the current dealer's notification settings.\n\n**This is a full replacement, not a partial update.** Any writable field you omit is reset to its default rather than left alone. Omitting the optional `email_special`, for example, clears it. Always read the current settings first, change what you need, and send the complete object back.\n\n`email_from`, `email_footer`, `sms_originator`, and `caller_id` are mandatory on every call. Omitting any of them fails with error code 7 and an `errors` array naming the missing field.","operationId":"dealerSettingsNotificationUpdate","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/NotificationSettings"},{"type":"object","required":["email_from","email_footer","sms_originator","caller_id"]}]}}}},"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"}}}}}}
```

#### Errors

[General](/docs/navixy-api/general/errors.md#error-codes) types only.

Omitting any of `email_from`, `email_footer`, `sms_originator`, or `caller_id` returns error code 7 with an `errors` array naming the missing field.


---

# 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/notification.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.