Delete a mailing list
This request is used for deleting a mailing list on a domain.
The mailing list can be specified using the email address or the mailbox ID. You can get the ID in the response to the Get domain mailing lists request.
Request syntax
The request should be sent over the HTTPS protocol using the POST method.
POST /api2/admin/email/ml/del
Host: pddimp.yandex.ru
PddToken: <PDD token>
...
domain=<domain name>
&(maillist=<email address or username of mailing list>|maillist_uid=<mailing list ID>)
Headers:
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”. The request should only pass one of the parameters: |
maillist_uid | Integer | ID of the mailing list. You can get the ID value in the response to the Get domain mailing lists request. The request should only pass one of the 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”. The request should only pass one of the parameters: |
maillist_uid | Integer | ID of the mailing list. You can get the ID value in the response to the Get domain mailing lists request. The request should only pass one of the parameters: |
POST /api2/registrar/email/ml/del
Host: pddimp.yandex.ru
PddToken: <PDD token>
Authorization: OAuth <OAuth token>
...
domain=<domain name>
&(maillist=<email address or username of mailing list>|maillist_uid=<mailing list ID>)
Headers:
Name | Description |
---|---|
PddToken | |
Authorization |
Name | Description |
---|---|
PddToken | |
Authorization |
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”. The request should only pass one of the parameters: |
maillist_uid | Integer | ID of the mailing list. You can get the ID value in the response to the Get domain mailing lists request. The request should only pass one of the 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”. The request should only pass one of the parameters: |
maillist_uid | Integer | ID of the mailing list. You can get the ID value in the response to the Get domain mailing lists request. The request should only pass one of the parameters: |
Request example
POST /api2/admin/email/ml/del HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
...
domain=domain.com&maillist_uid=123456789
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -d 'domain=domain.com&maillist_uid=123456789' 'https://pddimp.yandex.ru/api2/admin/email/ml/del'
POST /api2/admin/email/ml/del HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000
...
domain=domain.com&maillist_uid=123456789
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -H 'Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000' -d 'domain=domain.com&maillist_uid=123456789' 'https://pddimp.yandex.ru/api2/admin/email/ml/del'
Response structure
Name | Type of value | Description |
---|---|---|
domain | String | Name of the domain. |
maillist | String | Email address of the mailing list. |
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:
|
Name | Type of value | Description |
---|---|---|
domain | String | Name of the domain. |
maillist | String | Email address of the mailing list. |
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:
|