Создать правило автоответа или пересылки

  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/user_rules

Path-параметры

orgId *

integer

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

userId *

string

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

orgId *

integer

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

userId *

string

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

Тело запроса

{
  "autoreply": {
    "ruleName": string,
    "text": string
  },
  "forward": {
    "address": string,
    "ruleName": string,
    "withStore": boolean
  }
}
Скопировано

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

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

Поля

autoreply

object

autoreply.ruleName

string

Название правила.

autoreply.text

string

Текст автоответа.

forward

object

forward.address

string

Email получателя пересылаемого письма.

forward.ruleName

string

Название правила.

forward.withStore

boolean

Признак того, нужно ли сохранять копию письма в ящике исходного получателя.

autoreply

object

autoreply.ruleName

string

Название правила.

autoreply.text

string

Текст автоответа.

forward

object

forward.address

string

Email получателя пересылаемого письма.

forward.ruleName

string

Название правила.

forward.withStore

boolean

Признак того, нужно ли сохранять копию письма в ящике исходного получателя.

Ответы

Код 200

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

{
  "ruleId": integer
}
Скопировано

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

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

Поля

ruleId

integer

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

ruleId

integer

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

Код 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