enterprisemail

Reseller should have signed up for enterpriseemailus or enterpriseemailin

Delete Email Accounts

Description

Deletes Email Accounts from an existing Enterprise Email Order.

Parameters

Name Data Type Required / Optional
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required The Order Id for which Email Accounts need to be deleted.
no-of-accounts Integer Required The number of Email Accounts to be deleted.

HTTP Method

POST

Example Test URL Request

US Server


https://test.httpapi.com/api/enterpriseemail/us/delete-email-account.json?auth-userid=0&api-key=key&order-id=0&no-of-accounts=2

India Server


https://test.httpapi.com/api/enterpriseemail/in/delete-email-account.json?auth-userid=0&api-key=key&order-id=0&no-of-accounts=2

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order Id of the Enterprise Email Order (entityid)

  • Action Type (actiontype)

  • Description of the Email Accounts Deletion Action (actiontypedesc)

  • Action Id of the Email Accounts Deletion Action (eaqid)

  • Email Accounts Deletion Action Status (actionstatus)

  • Description of the Email Accounts Deletion Action Status (actionstatusdesc)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Add Email Accounts

Description

Adds Email Accounts to an existing Enterprise Email Order.

Parameters

Name Data Type Required / Optional
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required The Order Id for which Email Accounts need to be added.
no-of-accounts Integer Required The number of Email Accounts to be added.
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

US Server


https://test.httpapi.com/api/enterpriseemail/us/add-email-account.json?auth-userid=0&api-key=key&order-id=0&no-of-accounts=10&invoice-option=NoInvoice

India Server


https://test.httpapi.com/api/enterpriseemail/in/add-email-account.json?auth-userid=0&api-key=key&order-id=0&no-of-accounts=10&invoice-option=NoInvoice

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order Id of the Enterprise Email Order (entityid)

  • Action Type (actiontype)

  • Description of the Email Accounts Addition Action (actiontypedesc)

  • Action Id of the Email Accounts Addition Action (eaqid)

  • Email Accounts Addition Action Status (actionstatus)

  • Description of the Email Accounts Addition Action Status (actionstatusdesc)

  • Invoice Id of the Domain Renewal Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Selling Curreny Amount (sellingamount)

  • Customer Id associated with the Domain Name Order (customerid)

Note

invoiceid, sellingcurrencysymbol, sellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Renew

Description

Renews an existing Enterprise Email Order.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required The Order Id which is to be renewed.
months Integer Required The number of months for which the Order is to be renewed.
no-of-accounts Integer Optional Additional Email Accounts to be purchased for the Enterprise Email Order, if required.
auto-renew Boolean Required

Enables / Disables the Auto Renewal setting for the Order.

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

US Server


https://test.httpapi.com/api/enterpriseemail/us/renew.json?auth-userid=0&api-key=key&order-id=0&months=0&invoice-option=NoInvoice

India Server


https://test.httpapi.com/api/enterpriseemail/in/renew.json?auth-userid=0&api-key=key&order-id=0&months=0&invoice-option=NoInvoice

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order Id of the Enterprise Email Order (entityid)

  • Action Type (actiontype)

  • Description of the Enterprise Email Order Renewal Action (actiontypedesc)

  • Action Id of the Enterprise Email Order Renewal Action (eaqid)

  • Enterprise Email Order Renewal Action Status (actionstatus)

  • Description of the Enterprise Email Order Renewal Action Status (actionstatusdesc)

  • Invoice Id of the Enterprise Email Order Renewal Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Selling Curreny Amount (sellingamount)

  • Customer Id associated with the Enterprise Email Order (customerid)

Note

invoiceid, sellingcurrencysymbol, sellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Add

Description

Places an Enterprise Email Order for the specified domain name.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
domain-name String Required The domain name for which the Order is placed.
customer-id Integer Required The Customer under whom the Order should be added.
months Integer Required The number of months for which the Order is placed.
no-of-accounts Integer Required The number of email accounts required.
auto-renew Boolean Required

Enables / Disables the Auto Renewal setting for the Order.

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

US Server


https://test.httpapi.com/api/enterpriseemail/us/add.json?auth-userid=0&api-key=key&domain-name=name&customer-id=0&months=0&no-of-accounts=15&invoice-option=NoInvoice

India Server


https://test.httpapi.com/api/enterpriseemail/in/add.json?auth-userid=0&api-key=key&domain-name=name&customer-id=0&months=0&no-of-accounts=15&invoice-option=NoInvoice

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order Id of the Domain Registration Order (entityid)

  • Action Type (actiontype)

  • Description of the Domain Registration Action (actiontypedesc)

  • Action Id of the Domain Registration Action (eaqid)

  • Domain Registration Action Status (actionstatus)

  • Description of the Domain Registration Action Status (actionstatusdesc)

  • Invoice Id of the Domain Registration Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Selling Price for Customers (sellingamount)

  • Customer Id associated with the Domain Registration Order (customerid)

Note

invoiceid, sellingcurrencysymbol, sellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Deleting Email Accounts from your Enterprise Email Order

You may delete Email Accounts from your Enterprise Email Order, from within your Control Panel.

Note
  • Email Account(s) currently in use cannot be delete through the process mentioned below. Such Email Account(s) need to be deleted from the Email Administration interface. See details

  • Deletion of Email Account(s) will not result in any refund.

    To Delete Email Accounts from an Enterprise Email Order

    1. Login to your Control Panel, Search for the domain name for which you have purchased the Enterprise Email Order and go to the
      Order Information view. See details

    2. Click the Delete Email Account(s) link.

      Note

      If your Enterprise Email Order has Expired, you will not be able to delete Email Accounts, until you have Renewed your existing Order.

    3. Mention the number of Accounts to be deleted.

    4. Click the Delete Now button.

    5. Confrim the deletion by clicking the OK button.

    Adding Email Accounts to your Enterprise Email Order

    You may add Email Accounts to your Enterprise Email Order, from within your Control Panel.

    To Add Email Accounts to an Enterprise Email Order

    1. Login to your Control Panel, Search for the domain name for which you have purchased the Enterprise Email Order and go to the
      Order Information view. See details

    2. Click the Buy More button.

      Note

      If your Enterprise Email Order has Expired, you will not be able to add Email Accounts, until you have Renewed your existing Order.

    3. Mention the number of Email Accounts to be added in the Add Email Account(s) field.

    4. Click the Buy Now button.

    5. Proceed to pay for the Invoice generated.