reseller

is added when reseller has a customer specific business

Delete Mailing List

Description

Deletes mailing lists.

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 or Digital Certificate Order
list-address-prefixes String Required A CSV of list address prefixes to be deleted on a particular domain name.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/mail/mailinglist/delete.json?auth-userid=0&api-key=key&order-id=0&list-address-prefixes=list1,list2

Response

Returns "SUCCESS" as the status if a mailing list deleted successfully.

Delete Subscribers

Description

Deletes subscribers from 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 or Digital Certificate Order
list-address String Required Mailing list address
subscribers String Required A CSV list of email addresses

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/mail/mailinglist/delete-subscribers.json?auth-userid=0&api-key=key&order-id=0&[email protected]&[email protected],[email protected]

Response

Returns "SUCCESS" as the status if subscribers deleted from the specified mailing list successfully.

List Subscribers

Description

Fetches the list of subscribers of 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 or Digital Certificate Order
list-address String Required Mailing list address
reverse-sort Boolean Optional Values can be: true or false.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/mail/mailinglist/subscribers.json?auth-userid=0&api-key=key&order-id=0&[email protected]

Response

Returns a list of the subscribers of a mailing list.

Add Subscribers

Description

Adds subscribers to 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 or Digital Certificate Order
list-address String Required Mailing list address
subscribers String Required A CSV list of email addresses

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/mail/mailinglist/add-subscribers.json?auth-userid=0&api-key=key&order-id=0&[email protected]&[email protected],[email protected]

Response

Returns "SUCCESS" as the status if subscribers added to the specified mailing list successfully.

Get Details

Description

Fetches the details of 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 or Digital Certificate Order
list-address String Required Mailing list address

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/mail/mailinglist.json?auth-userid=0&api-key=key&order-id=0&[email protected]

Response

Returns the details of a mailing list.

Get Mailing Lists Of Domain

Description

Fetches all the mailing lists of domain of the specified Order.

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 or Digital Certificate Order

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/mail/mailinglists.json?auth-userid=0&api-key=key&order-id=0

Response

Returns the list of all the mailing lists.

Modify Mailing List

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 or Digital Certificate 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&[email protected]&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.

Add Mailing List

Description

Adds a new 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 or Digital Certificate 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.
moderators String Required A CSV of email addresses
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/add.json?auth-userid=0&api-key=key&order-id=0&[email protected]&subscription-held=false&who-can-post=only_members&send-messages-for-moderation=false&reply-to=sender&[email protected],[email protected]

Response

Returns "SUCCESS" as the status if a mailing list added successfully.

Deactivate Catch-all Account

Description

Deactivates catch-all account.

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 or Digital Certificate Order

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/mail/domain/deactivate-catchall.json?auth-userid=0&api-key=key&order-id=0

Response

Returns "SUCCESS" as the status if catch-all account deactivated successfully.

Activate Catch-all Account

Description

Activates catch-all account.

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 or Digital Certificate Order
catchall-email String Required Email address which is a part of the domain of the order-id

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/mail/domain/activate-catchall.json?auth-userid=0&api-key=key&order-id=0&[email protected]

Response

Returns "SUCCESS" as the status if catch-all account activated successfully.

Subscribe to reseller