---
metadata:
  - name: generator
    content: Diplodoc Platform v5.64.0
alternate:
  - https://yandex.ru/dev/api360/doc/ru/mail-settings/patch-settings.md
  - href: https://yandex.ru/dev/api360/doc/ru/mail-settings/patch-settings.md
    type: text/markdown
    title: Markdown version
  - href: https://yandex.ru/dev/api360/doc/ru/llms.txt?revision=r21934284
    rel: describedby
sourcePath: docs/dev/api360/concepts/gw/mail-settings/patch-settings.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/api360/doc/ru/llms.txt?revision=r21934284

<!-- source: ru/openapi/mail-org/v1adminorgorg_idmail-settings-patch.md -->
<div class="openapi">

# Изменение настроек почты

<!-- markdownlint-disable-file -->

Обновляет настройки корпоративной почты в организации. Изменяются только настройки, переданные в запросе.

{% note info "" %}

Для выполнения запроса требуются все перечисленные права: `ya360_admin:mail_read_organization_settings` и `ya360_admin:mail_write_organization_settings`.

{% endnote %}

## Request

<div class="openapi__requests">

<div class="openapi__request__wrapper" style="--method: var(--dc-openapi-methods-patch);margin-bottom: 12px">

<div class="openapi__request">

PATCH {.openapi__method}
```text translate=no
https://cloud-api.yandex.net/v1/admin/org/{org_id}/mail-settings
```

</div>

</div>

</div>

### Path parameters

#|
|| **Name** | **Description** ||
||

_org_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Идентификатор организации.

_Example:_{.json-schema-reset .json-schema-example} `1234567`
{.table-cell}
||
|#{.json-schema-properties}

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "enable_imap": true,
  "enable_pop": true,
  "disable_disk_attachments": false,
  "friendly_org_users_is_external": true,
  "lock_employees_default_mail_domain": false,
  "show_external_contact_notification_on_compose": true,
  "show_external_contact_notification_on_read": true,
  "force_default_display_name": false
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_disable_disk_attachments_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Установлен ли запрет на:

- прикрепление к письмам файлов с Диска;
- автоматическую загрузку вложений из письма на Диск.

Возможные значения:

- `true` — запрет установлен;
- `false` — запрета нет.

{.table-cell}
||
||

_enable_imap_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Разрешить ли:

- новым сотрудникам, аккаунты которых будут создаваться на домене организации — доступ к своим почтовым ящикам по протоколу IMAP;
- всем сотрудникам с почтой на домене организации — доступ к настройкам в Почте, которые регулируют работу с почтовым ящиком по протоколу IMAP.

Возможные значения:

- `true` — доступы разрешены;
- `false` — доступы запрещены.

Значение по умолчанию — `true`.

{.table-cell}
||
||

_enable_pop_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Разрешить ли:

- новым сотрудникам, аккаунты которых будут создаваться на домене организации — доступ к своим почтовым ящикам по протоколу POP3;
- всем сотрудникам с почтой на домене организации — доступ к настройкам в Почте, которые регулируют работу с почтовым ящиком по протоколу POP3.

Возможные значения:

- `true` — доступы разрешены;
- `false` — доступы запрещены.

Значение по умолчанию — `true`.

{.table-cell}
||
||

_force_default_display_name_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Установить запрет для сотрудников на изменение отображаемого имени в интерфейсе Почты. При включенном запрете используется значение `DisplayName` из паспорта пользователя.

Возможные значения:

- `true` — запрет на изменение имени установлен;
- `false` — нет запрета на изменение имени.

Значение по умолчанию — `false`.

{.table-cell}
||
||

_friendly_org_users_is_external_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Приравнивать ли к внешним контактам сотрудников организаций, связанных с вашей организацией в федерацию.

Возможные значения:

- `true` — сотрудники связанных организаций приравниваются к внешним контактам и будут помечаться при включении настройки `show_external_contact_notification_on_compose` или `show_external_contact_notification_on_read`;
- `false` — сотрудники связанных организаций не помечаются вне зависимости от настроек `show_external_contact_notification_on_compose` или `show_external_contact_notification_on_read`.

Значение по умолчанию — `false`.

{.table-cell}
||
||

_lock_employees_default_mail_domain_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Установить ли запрет для сотрудников на переключение доменных и почтовых алиасов. При включенном запрете сотрудники не могут выбирать адрес отправителя для почтовых ящиков, которые имеют дополнительные адреса. [Что такое алиасы](https://yandex.ru/support/yandex-360/business/admin/ru/mail/mailbox-management/aliases)

Возможные значения:

- `true` — запрет на выбор адреса отправителя установлен;
- `false` — запрета на выбор адреса отправителя нет.

Значение по умолчанию — `false`.

{.table-cell}
||
||

_show_external_contact_notification_on_compose_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Предупреждать ли о том, что среди получателей создаваемых писем есть внешние контакты.

Возможные значения:

- `true` — показывать предупреждение;
- `false` — не показывать предупреждение.

Значение по умолчанию — `true`.

{.table-cell}
||
||

_show_external_contact_notification_on_read_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Предупреждать ли о том, что среди отправителей входящих писем есть внешние контакты.
Возможные значения:

- `true` — показывать предупреждение;
- `false` — не показывать предупреждение.

Значение по умолчанию — `false`.

{.table-cell}
||
|#{.json-schema-properties}

</div>

## Responses

<div class="openapi__response__code__200">

## 200 OK

Настройки корпоративной почты организации обновлены.

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "enable_imap": true,
  "enable_pop": true,
  "disable_disk_attachments": false,
  "friendly_org_users_is_external": true,
  "lock_employees_default_mail_domain": false,
  "show_external_contact_notification_on_compose": true,
  "show_external_contact_notification_on_read": true,
  "force_default_display_name": false
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_disable_disk_attachments_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Установлен ли запрет на:

- прикрепление к письмам файлов с Диска;
- автоматическую загрузку вложений из письма на Диск.

Возможные значения:

- `true` — запрет установлен;
- `false` — запрета нет.

{.table-cell}
||
||

_enable_imap_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Разрешить ли:

- новым сотрудникам, аккаунты которых будут создаваться на домене организации — доступ к своим почтовым ящикам по протоколу IMAP;
- всем сотрудникам с почтой на домене организации — доступ к настройкам в Почте, которые регулируют работу с почтовым ящиком по протоколу IMAP.

Возможные значения:

- `true` — доступы разрешены;
- `false` — доступы запрещены.

Значение по умолчанию — `true`.

{.table-cell}
||
||

_enable_pop_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Разрешить ли:

- новым сотрудникам, аккаунты которых будут создаваться на домене организации — доступ к своим почтовым ящикам по протоколу POP3;
- всем сотрудникам с почтой на домене организации — доступ к настройкам в Почте, которые регулируют работу с почтовым ящиком по протоколу POP3.

Возможные значения:

- `true` — доступы разрешены;
- `false` — доступы запрещены.

Значение по умолчанию — `true`.

{.table-cell}
||
||

_force_default_display_name_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Установить запрет для сотрудников на изменение отображаемого имени в интерфейсе Почты. При включенном запрете используется значение `DisplayName` из паспорта пользователя.

Возможные значения:

- `true` — запрет на изменение имени установлен;
- `false` — нет запрета на изменение имени.

Значение по умолчанию — `false`.

{.table-cell}
||
||

_friendly_org_users_is_external_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Приравнивать ли к внешним контактам сотрудников организаций, связанных с вашей организацией в федерацию.

Возможные значения:

- `true` — сотрудники связанных организаций приравниваются к внешним контактам и будут помечаться при включении настройки `show_external_contact_notification_on_compose` или `show_external_contact_notification_on_read`;
- `false` — сотрудники связанных организаций не помечаются вне зависимости от настроек `show_external_contact_notification_on_compose` или `show_external_contact_notification_on_read`.

Значение по умолчанию — `false`.

{.table-cell}
||
||

_lock_employees_default_mail_domain_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Установить ли запрет для сотрудников на переключение доменных и почтовых алиасов. При включенном запрете сотрудники не могут выбирать адрес отправителя для почтовых ящиков, которые имеют дополнительные адреса. [Что такое алиасы](https://yandex.ru/support/yandex-360/business/admin/ru/mail/mailbox-management/aliases)

Возможные значения:

- `true` — запрет на выбор адреса отправителя установлен;
- `false` — запрета на выбор адреса отправителя нет.

Значение по умолчанию — `false`.

{.table-cell}
||
||

_show_external_contact_notification_on_compose_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Предупреждать ли о том, что среди получателей создаваемых писем есть внешние контакты.

Возможные значения:

- `true` — показывать предупреждение;
- `false` — не показывать предупреждение.

Значение по умолчанию — `true`.

{.table-cell}
||
||

_show_external_contact_notification_on_read_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Предупреждать ли о том, что среди отправителей входящих писем есть внешние контакты.
Возможные значения:

- `true` — показывать предупреждение;
- `false` — не показывать предупреждение.

Значение по умолчанию — `false`.

{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__400">

## 400 Bad Request

Параметры запроса не заданы или заданы неверно.

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "error": "bad_request",
  "description": "Параметры запроса не заданы или заданы неверно.",
  "message": "Параметры запроса не заданы или заданы неверно.",
  "details": {}
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_description_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Техническое описание ошибки.

_Example:_{.json-schema-reset .json-schema-example} `Параметры запроса не заданы или заданы неверно.`
{.table-cell}
||
||

_error_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Код ошибки

_Example:_{.json-schema-reset .json-schema-example} `bad_request`
{.table-cell}
||
||

_message_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Сообщение об ошибке.

_Example:_{.json-schema-reset .json-schema-example} `Параметры запроса не заданы или заданы неверно.`
{.table-cell}
||
||

_details_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Type**: object" %}

#|
|#{.json-schema-properties}

{% endcut %}

Дополнительные детали ошибки

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__404">

## 404 Not Found

Запрашиваемая организация не найдена.

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "error": "not_found",
  "description": "Запрашиваемая организация не найдена.",
  "message": "Запрашиваемая организация не найдена.",
  "details": {}
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_description_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Техническое описание ошибки.

_Example:_{.json-schema-reset .json-schema-example} `Запрашиваемая организация не найдена.`
{.table-cell}
||
||

_error_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Код ошибки

_Example:_{.json-schema-reset .json-schema-example} `not_found`
{.table-cell}
||
||

_message_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Сообщение об ошибке.

_Example:_{.json-schema-reset .json-schema-example} `Запрашиваемая организация не найдена.`
{.table-cell}
||
||

_details_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Type**: object" %}

#|
|#{.json-schema-properties}

{% endcut %}

Дополнительные детали ошибки

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

</div>
<!-- endsource: ru/openapi/mail-org/v1adminorgorg_idmail-settings-patch.md -->


[*Deprecated]: No longer supported, please use an alternative and newer version.