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. |
| 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
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.