Подписать на рассылку
Для управления доменами, пользователями и организациями используйте сервис Яндекс 360 для бизнеса.
Запрос позволяет добавить почтовый ящик в рассылку.
Как рассылку, так и подписчика можно задать с помощью одного из двух атрибутов: email-адреса или идентификатора. Идентификатор рассылки можно получить в ответе на запрос Получить рассылки домена, идентификатор подписчика — в ответе на запрос Получить список почтовых ящиков.
Синтаксис запроса
Запрос следует отправлять по протоколу HTTPS с помощью метода POST.
POST /api2/admin/email/ml/subscribe
Host: pddimp.yandex.ru
PddToken: <ПДД-токен>
...
domain=<имя домена>
&(maillist=<email-адрес или логин рассылки>|maillist_uid=<идентификатор рассылки>)
&(subscriber=<email-адрес подписчика>|subscriber_uid=<идентификатор подписчика>)
[&can_send_on_behalf=<статус подписчика>]
Заголовки:
Параметры:
Параметр | Тип | Значение |
---|---|---|
Обязательные | ||
domain | Строка | Имя домена. |
maillist | Строка | Email-адрес рассылки в формате «login@domain.ru» или «login». В запросе нужно передать только один из параметров: |
maillist_uid | Число | Идентификатор рассылки. Значение идентификатора можно получить в ответе на запрос Получить рассылки домена. В запросе нужно передать только один из параметров: |
subscriber | Строка | Email-адрес подписчика. В запросе нужно передать только один из параметров: |
subscriber_uid | Число | Идентификатор подписчика. Значение идентификатора можно получить в ответе на запрос Получить список почтовых ящиков. В запросе нужно передать только один из параметров: |
Необязательные | ||
can_send_on_behalf | Строка | Статус подписчика. Допустимые значения:
|
Параметр | Тип | Значение |
---|---|---|
Обязательные | ||
domain | Строка | Имя домена. |
maillist | Строка | Email-адрес рассылки в формате «login@domain.ru» или «login». В запросе нужно передать только один из параметров: |
maillist_uid | Число | Идентификатор рассылки. Значение идентификатора можно получить в ответе на запрос Получить рассылки домена. В запросе нужно передать только один из параметров: |
subscriber | Строка | Email-адрес подписчика. В запросе нужно передать только один из параметров: |
subscriber_uid | Число | Идентификатор подписчика. Значение идентификатора можно получить в ответе на запрос Получить список почтовых ящиков. В запросе нужно передать только один из параметров: |
Необязательные | ||
can_send_on_behalf | Строка | Статус подписчика. Допустимые значения:
|
POST /api2/registrar/email/ml/subscribe
Host: pddimp.yandex.ru
PddToken: <ПДД-токен>
Authorization: OAuth <OAuth-токен>
...
domain=<имя домена>
&(maillist=<email-адрес или логин рассылки>|maillist_uid=<идентификатор рассылки>)
&(subscriber=<email-адрес подписчика>|subscriber_uid=<идентификатор подписчика>)
[&can_send_on_behalf=<статус подписчика>]
Заголовки:
Название | Описание |
---|---|
PddToken | |
Authorization |
Название | Описание |
---|---|
PddToken | |
Authorization |
Параметры:
Параметр | Тип | Значение |
---|---|---|
Обязательные | ||
domain | Строка | Имя домена. |
maillist | Строка | Email-адрес рассылки в формате «login@domain.ru» или «login». В запросе нужно передать только один из параметров: |
maillist_uid | Число | Идентификатор рассылки. Значение идентификатора можно получить в ответе на запрос Получить рассылки домена. В запросе нужно передать только один из параметров: |
subscriber | Строка | Email-адрес подписчика. В запросе нужно передать только один из параметров: |
subscriber_uid | Число | Идентификатор подписчика. Значение идентификатора можно получить в ответе на запрос Получить список почтовых ящиков. В запросе нужно передать только один из параметров: |
Необязательные | ||
can_send_on_behalf | Строка | Статус подписчика. Допустимые значения:
|
Параметр | Тип | Значение |
---|---|---|
Обязательные | ||
domain | Строка | Имя домена. |
maillist | Строка | Email-адрес рассылки в формате «login@domain.ru» или «login». В запросе нужно передать только один из параметров: |
maillist_uid | Число | Идентификатор рассылки. Значение идентификатора можно получить в ответе на запрос Получить рассылки домена. В запросе нужно передать только один из параметров: |
subscriber | Строка | Email-адрес подписчика. В запросе нужно передать только один из параметров: |
subscriber_uid | Число | Идентификатор подписчика. Значение идентификатора можно получить в ответе на запрос Получить список почтовых ящиков. В запросе нужно передать только один из параметров: |
Необязательные | ||
can_send_on_behalf | Строка | Статус подписчика. Допустимые значения:
|
Пример запроса
POST /api2/admin/email/ml/subscribe HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
...
domain=domain.com&maillist_uid=123456789&subscriber_uid=987654321&can_send_on_behalf=yes
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -d 'domain=domain.com&maillist_uid=123456789&subscriber_uid=987654321' 'https://pddimp.yandex.ru/api2/admin/email/ml/subscribe'
POST /api2/admin/email/ml/subscribe HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000
...
domain=domain.com&maillist_uid=123456789&subscriber_uid=987654321&can_send_on_behalf=yes
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -H 'Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000' -d 'domain=domain.com&maillist_uid=123456789&subscriber_uid=987654321' 'https://pddimp.yandex.ru/api2/admin/email/ml/subscribe'
Структура ответа
{
"domain": "{имя домена}",
"maillist": "{email-адрес рассылки}",
"uid": "{идентификатор рассылки}",
"subscriber": "{email-адрес подписчика}",
"success": "{статус выполнения запроса}"
}
{
"domain": "{имя домена}",
"success": "{статус выполнения запроса}",
"error": "{код ошибки}"
}
Название | Тип значения | Описание |
---|---|---|
domain | Строка | Имя домена. |
maillist | Строка | Email-адрес рассылки. |
uid | Число | Идентификатор рассылки. |
subscriber | Строка | Email-адрес подписчика. |
success | Строка | Статус выполнения запроса. Возможные значения:
|
error | Строка | Код ошибки. Ключ включается в ответ, если запрос выполнен с ошибкой. Возможные значения:
|
Название | Тип значения | Описание |
---|---|---|
domain | Строка | Имя домена. |
maillist | Строка | Email-адрес рассылки. |
uid | Число | Идентификатор рассылки. |
subscriber | Строка | Email-адрес подписчика. |
success | Строка | Статус выполнения запроса. Возможные значения:
|
error | Строка | Код ошибки. Ключ включается в ответ, если запрос выполнен с ошибкой. Возможные значения:
|