Knowledge Base
Categories: Business & Enterprise Email API
Modify Mailing Lists Using the API
When you want to update mailing list settings. This article explains how to modify mailing list configuration such as posting permissions, moderation settings, reply behavior, subscription controls, and footer text using the API for supported email services.
Description
Modifies the specified mailing list.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| order-id | Integer | Required | Order ID of the Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email Order |
| list-address | String | Required | An email address representing mailing list |
| subscription-held | Boolean | Required | Values can be: true or false. |
| who-can-post | String | Required | Values can be: anyone, only_members or only_moderators. |
| send-messages-for-moderation | Boolean | Required | Values can be: true or false. |
| reply-to | String | Required | Values can be: sender, entire_list or custom_address. |
| custom-email | String | Optional | An email address, required in case reply_to=custom_address |
| footer-text | String | Optional | Text value for the footer |
HTTP Method
POST
Example Test URL Request
https://test.httpapi.com/api/mail/mailinglist/update.json?auth-userid=0&api-key=key&order-id=0&list-address=list-name@domainname.com&subscription-held=false&who-can-post=only_members&send-messages-for-moderation=false&reply-to=sender
Response
Returns "SUCCESS" as the status if a mailing list modified successfully.
Did you find this article helpful?