reseller

is added when reseller has a customer specific business

Get Catch-all Account

Description

Gets email address of a catch-all account of a domain.

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/domain/catchall.json?auth-userid=0&api-key=key&order-id=0

Response

Returns catch-all email address if catch-all account is activated on the domain.

Enable SSL

Description

Enables SSL for an existing Web Hosting Order. To learn more, click here.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required The OrderId for which SSL needs to be enabled.
invoice-option String Required This parameter will decide how the Customer Invoices will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/webservices/enable-ssl.json?auth-userid=0&api-key=key&order-id=0&invoice-option=NoInvoice

Response

Returns a map of the execution details of the enabling of SSL operation.

Understanding Pricing Bands

Pricing Bands

Note

The Pricing Bands feature is presently available only for the Web Services Product.

Pricing Bands allow pricing to be determined based on usage of various resource parameters. These resource parameters are:

  • Number of Email Accounts

  • Amount of Web Space

  • Amount of Data Transfer

  • Number of Website Builder Pages

This ensures that you only get proportionally charged when either:

  • your Customers purchase small Plans, and/or

  • your Sub-Resellers purchase small Plans on behalf of their Customers.

Pricing Bands Example for Windows Web Hosting and Email Plans Category

Let's assume that the following table is visible to you when you view your Sub-Resellers Pricing for the Windows Web Hosting and Email Plans Category:

Pricing Add Renew Add Dedicated IP/SSL

Band 1

Web Space

Data Transfer

Email Accounts

Cost Price


Selling Price

USD 1 / month


Per Month

USD

USD 1 / month


Per Month

USD

USD 1 / month


Per Month

USD

Band 2

Web Space

Data Transfer

Email Accounts

Cost Price


Selling Price

USD 2 / month


Per Month

USD

USD 2 / month


Per Month

USD

USD 2 / month


Per Month

USD

Band 3

Web Space

Data Transfer

Email Accounts

Cost Price


Selling Price

USD 5 / month


Per Month

USD

USD 5 / month


Per Month

USD

USD 5 / month


Per Month

USD

Cancel

The following can be interpreted from the above table:

  • If you set a Plan (for Customers) with 10 MB of Web Space, 1 GB Data Transfer and 5 Email Accounts, then you would be charged at USD 1 per month. This is because this Plan
    matches Band 1's pricing set by for you.

  • If you set a Plan (for Customers) with 20 MB of Web Space, 2 GB Data Transfer and 5 Email Accounts, then you would be charged at USD 2 per month. You will be charged as per
    Band 2's pricing because the various resource parameters you have selected for this Plan are higher than those defined for Band 1 but lower than Band 2's.

  • If you set a Plan (for Customers) with 100 MB of Web Space, 10 GB Data Transfer and 500 Email Accounts, then you would be charged at USD 5 per month. You will be charged as per
    Band 3's pricing because the various resource parameters you have selected for this Plan are higher than those defined for Band 2 but lower than Band 3's.

  • In each of the Bands, you need to submit your Selling Price for your Sub-Resellers. These Pricing Bands will be applicable to them when:

    • they create Plans for their Customers,

    • set pricing for the Pricing Bands for their Sub-Resellers.

Getting .CA Registrant Agreement

Description

Gets the Registrant Agreement mandated by the Canadian Internet Registration Authority (CIRA).

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/contacts/dotca/registrantagreement.xml?auth-userid=0&api-key=key

Response

Returns the Registrant Agreement and its Version number.

Note

It is mandatory for the Reseller to display the latest version of the CIRA Registrant Agreement and have each Registrant agree to the same, prior to registering a domain name.

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&list-address=list1@domainname.com&subscribers=user1@domainname.com,user2@domainname.com

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&list-address=list1@domainname.com

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&list-address=list1@domainname.com&subscribers=user1@domainname.com,user2@domainname.com

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&list-address=list1@domainname.com

Response

Returns the details of a mailing list.