Get domain mailing lists
This request is used for getting all the domain's mailing lists.
Request syntax
The request should be sent over the HTTPS protocol using the GET method.
GET /api2/admin/email/ml/list?
domain=<domain name>
Host: pddimp.yandex.ru
PddToken: <PDD token>
Headers:
Parameters:
Parameter | Type | Value |
---|---|---|
Mandatory | ||
domain | String | Name of the domain. |
Parameter | Type | Value |
---|---|---|
Mandatory | ||
domain | String | Name of the domain. |
GET /api2/registrar/email/ml/list?
domain=<domain name>
Host: pddimp.yandex.ru
PddToken: <PDD token>
Authorization: OAuth <OAuth token>
Headers:
Name | Description |
---|---|
PddToken | |
Authorization |
Name | Description |
---|---|
PddToken | |
Authorization |
Parameters:
Parameter | Type | Value |
---|---|---|
Mandatory | ||
domain | String | Name of the domain. |
Parameter | Type | Value |
---|---|---|
Mandatory | ||
domain | String | Name of the domain. |
Request example
GET /api2/admin/email/ml/list?domain=domain.com HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' 'https://pddimp.yandex.ru/api2/admin/email/ml/list?domain=domain.com'
GET /api2/admin/email/ml/list?domain=domain.com HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -H 'Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000' 'https://pddimp.yandex.ru/api2/admin/email/ml/list?domain=domain.com'
Response structure
Name | Type of value | Description |
---|---|---|
domain | String | Name of the domain. |
success | String | Status of request execution. Possible values:
|
error | String | Error code. Included in the response if the request resulted in an error. Possible values:
|
maillists | Array | Properties of mailing lists. Each object in the array corresponds to a single mailing list. |
Keys for objects in the maillists array | ||
maillist | String | Email address of the mailing list. |
uid | Integer | ID of the mailing list. |
cnt | Integer | Number of subscribers to the mailing list. |
Name | Type of value | Description |
---|---|---|
domain | String | Name of the domain. |
success | String | Status of request execution. Possible values:
|
error | String | Error code. Included in the response if the request resulted in an error. Possible values:
|
maillists | Array | Properties of mailing lists. Each object in the array corresponds to a single mailing list. |
Keys for objects in the maillists array | ||
maillist | String | Email address of the mailing list. |
uid | Integer | ID of the mailing list. |
cnt | Integer | Number of subscribers to the mailing list. |