Add a mailing list

A mailing list is an email address that is associated with a group of mailboxes. Messages that are sent to the mailing list will be delivered to each of the associated mailboxes.

This request is used for adding a mailing list for the domain.

  1. Request syntax
  2. Request example
  3. Response structure

Request syntax

The request should be sent over the HTTPS protocol using the POST method.

POST /api2/admin/email/ml/add
Host: pddimp.yandex.ru
PddToken: <PDD token>
...

domain=<domain name>
&maillist=<email or username of the mailing list>

Headers:

Name Description
PddToken

PDD token.
Name Description
PddToken

PDD token.

Parameters:

Parameter Type Value
Mandatory
domain String

Name of the domain.
maillist String

The email address of the mailing list, in the format “username@domain.ru” or “username”.
Parameter Type Value
Mandatory
domain String

Name of the domain.
maillist String

The email address of the mailing list, in the format “username@domain.ru” or “username”.

Request example

POST /api2/admin/email/ml/add HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
...
        domain=domain.com&maillist=newmaillist
cURL
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -d 'domain=domain.com&maillist=newmaillist' 'https://pddimp.yandex.ru/api2/admin/email/ml/add'

Response structure

{
  "domain": "{domain name}",
  "maillist":"{email address of the mailing list}",
  "uid": "{mailing list ID}",
  "success": "{status of request execution}"
}
Name Type of value Description
domain String

Name of the domain.
maillist String

Email address of the mailing list.
uid Integer

ID of the mailing list.
success String

Status of request execution.

Possible values:
  • ok — Request executed successfully.
  • error — Request executed with error.
error String

Error code.

Included in the response if the request resulted in an error.

Possible values:
  • unknown — A temporary failure or API error occurred (repeat the request again later).
  • no_token (no_domain, no_ip ) — A mandatory parameter was omitted.
  • bad_domain — The domain name was not specified or does not conform to the RFC.
  • prohibited — A forbidden domain name.
  • bad_token (bad_login, bad_passwd) — An invalid PDD token (or username/password) was passed.
  • no_auth — The PddToken header was omitted.
  • not_allowed — This operation is not allowed for this user (the user is not the domain administrator).
  • blocked — Blocked domain (for example, due to spam and so on).
  • occupied — The domain name is in use by another user.
  • domain_limit_reached — Exceeded the acceptable number of connected domains (50).
  • no_reply — Yandex.Mail for Domain cannot connect to the server source for the import.
Name Type of value Description
domain String

Name of the domain.
maillist String

Email address of the mailing list.
uid Integer

ID of the mailing list.
success String

Status of request execution.

Possible values:
  • ok — Request executed successfully.
  • error — Request executed with error.
error String

Error code.

Included in the response if the request resulted in an error.

Possible values:
  • unknown — A temporary failure or API error occurred (repeat the request again later).
  • no_token (no_domain, no_ip ) — A mandatory parameter was omitted.
  • bad_domain — The domain name was not specified or does not conform to the RFC.
  • prohibited — A forbidden domain name.
  • bad_token (bad_login, bad_passwd) — An invalid PDD token (or username/password) was passed.
  • no_auth — The PddToken header was omitted.
  • not_allowed — This operation is not allowed for this user (the user is not the domain administrator).
  • blocked — Blocked domain (for example, due to spam and so on).
  • occupied — The domain name is in use by another user.
  • domain_limit_reached — Exceeded the acceptable number of connected domains (50).
  • no_reply — Yandex.Mail for Domain cannot connect to the server source for the import.