Изменить основной адрес и подписи

  1. HTTP-запрос
  2. Path-параметры
  3. Тело запроса
    1. Представление
    2. Поля
  4. Ответы
    1. Код 200
      1. Представление
      2. Поля
    2. Код 401
      1. Представление
      2. Поля
    3. Код 403
      1. Представление
      2. Поля
    4. Код 404
      1. Представление
      2. Поля
    5. Код 500
      1. Представление
      2. Поля

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

Ограничение. Чтобы выполнить запрос, приложению требуется разрешение на управление настройками почты пользователя. Убедитесь, что вы включили его при настройке приложения на OAuth-сервере Яндекса.

HTTP-запрос

POST https://api360.yandex.net/admin/v1/org/{orgId}/mail/users/{userId}/settings/sender_info

Path-параметры

orgId *

integer

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

userId *

string

Идентификатор пользователя.

orgId *

integer

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

userId *

string

Идентификатор пользователя.

Тело запроса

{
  "defaultFrom": string,
  "fromName": string,
  "signPosition": string,
  "signs": [
    {
      "emails": [
        string
      ],
      "isDefault": boolean,
      "lang": string,
      "text": string
    }
  ]
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

defaultFrom

string

Отправлять письма с адреса.

fromName

string

Имя отправителя.

signPosition

string

Расположение подписи.

  • bottom: Внизу всего письма.
  • under: Сразу после ответа.

Значение по умолчанию: bottom.

Возможные значения
  1. bottom
  2. under

signs[]

array

Подписи.

signs[].emails[]

array

Привязать к адресу.

signs[].isDefault

boolean

Является ли подписью по умолчанию.

signs[].lang

string

Язык подписи.

signs[].text

string

Текст подписи, поддерживает разметку html, в том числе изображения.

defaultFrom

string

Отправлять письма с адреса.

fromName

string

Имя отправителя.

signPosition

string

Расположение подписи.

  • bottom: Внизу всего письма.
  • under: Сразу после ответа.

Значение по умолчанию: bottom.

Возможные значения
  1. bottom
  2. under

signs[]

array

Подписи.

signs[].emails[]

array

Привязать к адресу.

signs[].isDefault

boolean

Является ли подписью по умолчанию.

signs[].lang

string

Язык подписи.

signs[].text

string

Текст подписи, поддерживает разметку html, в том числе изображения.

Ответы

Код 200

Запрос успешно выполнен.

{
  "defaultFrom": string,
  "fromName": string,
  "signPosition": string,
  "signs": [
    {
      "emails": [
        string
      ],
      "isDefault": boolean,
      "lang": string,
      "text": string
    }
  ]
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

defaultFrom

string

Отправлять письма с адреса.

fromName

string

Имя отправителя.

signPosition

string

Расположение подписи.

  • bottom: Внизу всего письма.
  • under: Сразу после ответа.

Значение по умолчанию: bottom.

Возможные значения
  1. bottom
  2. under

signs[]

array

Подписи.

signs[].emails[]

array

Привязать к адресу.

signs[].isDefault

boolean

Является ли подписью по умолчанию.

signs[].lang

string

Язык подписи.

signs[].text

string

Текст подписи, поддерживает разметку html, в том числе изображения.

defaultFrom

string

Отправлять письма с адреса.

fromName

string

Имя отправителя.

signPosition

string

Расположение подписи.

  • bottom: Внизу всего письма.
  • under: Сразу после ответа.

Значение по умолчанию: bottom.

Возможные значения
  1. bottom
  2. under

signs[]

array

Подписи.

signs[].emails[]

array

Привязать к адресу.

signs[].isDefault

boolean

Является ли подписью по умолчанию.

signs[].lang

string

Язык подписи.

signs[].text

string

Текст подписи, поддерживает разметку html, в том числе изображения.

Код 401

Пользователь не авторизован.

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string

Код 403

У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string

Код 404

Запрашиваемый ресурс не найден.

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string

Код 500

Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string