Правило отправителя

API 0.16.0OpenAPIllms-full.txt

PUT/v1/mailboxes/{mailbox_id}/sender-rules

Создаёт или обновляет правило для адреса sender. Укажите action=spam, чтобы направлять новые письма отправителя в спам, или action=allow, чтобы разрешить его письма. Правило применяется к будущим входящим письмам.

Авторизация и области доступа · Ошибки и повторы

Запрос

curl -X PUT 'https://adapt-mail.com/v1/mailboxes/<mailbox_id>/sender-rules' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Content-Type: application/json' \
  --data '{"sender":"[email protected]","action":"spam"}'

Параметры

mailbox_idpathОбязательно

integer

X-Customer-IDheader

Вариант 1

string

Вариант 2

null

Тело запроса · application/json

object

senderОбязательно

string

action

string

Допустимые значения: "spam" "allow"

По умолчанию: "spam"

Неизвестные поля не принимаются.

Ответы

202 Успешный ответ

application/json

object

id

string · uuid

Идентификатор операции для проверки состояния и отмены ожидающей отправки.

kind

string

mailbox_id

Вариант 1

integer

Вариант 2

null

status

string

Допустимые значения: "queued" "running" "succeeded" "failed" "uncertain" "cancelled"

run_at

string

Дата и время в UTC. Если смещение отсутствует, значение также представляет UTC.

created_at

string

Дата и время в UTC. Если смещение отсутствует, значение также представляет UTC.

completed_at

Вариант 1

string

Дата и время в UTC. Если смещение отсутствует, значение также представляет UTC.

Вариант 2

null

error

Причина ошибки, если операция не завершилась успешно.

Вариант 1

string

Вариант 2

null

result

Результат выполнения операции. Для отправки содержит сведения о принятых и отклонённых получателях.

Вариант 1

object

Вариант 2

null

401 Требуется вход

application/json

object

detail

Вариант 1

string

Вариант 2

object

code

string

message

string

Вариант 3

array

Элементы массива

object

403 Нет доступа

application/json

object

detail

Вариант 1

string

Вариант 2

object

code

string

message

string

Вариант 3

array

Элементы массива

object

404 Ресурс не найден

application/json

object

detail

Вариант 1

string

Вариант 2

object

code

string

message

string

Вариант 3

array

Элементы массива

object

409 Конфликт состояния

application/json

object

detail

Вариант 1

string

Вариант 2

object

code

string

message

string

Вариант 3

array

Элементы массива

object

422 Ошибка валидации

application/json

object

detail

array

Элементы массива

object

locОбязательно

array

Элементы массива

Вариант 1

string

Вариант 2

integer

msgОбязательно

string

typeОбязательно

string

503 Временная недоступность

application/json

object

detail

Вариант 1

string

Вариант 2

object

code

string

message

string

Вариант 3

array

Элементы массива

object