reseller

is added when reseller has a customer specific business

Suspend User

Description

Suspends a user.

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
email String Required Email address of user

HTTP Method

POST

Example Test URL Request


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

Response

Returns "SUCCESS" as the status if a user suspended successfully.

Modify User Details

Description

Modifies details of a user.

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
email String Required Email address of a user
notification-email String Required Notification email address of a user
first-name String Required First name of a user
last-name String Required Last name of a user

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/mail/user/modify.json?auth-userid=0&api-key=key&order-id=0&[email protected]&[email protected]&first-name=firstname1&last-name=lastname1

Response

Returns "SUCCESS" as the status if user modified successfully.

Get User Details

Description

Gets the details of a user.

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
email String Required Email address of user

HTTP Method

GET

Example Test URL Request


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

Response

Returns the details of a user.

Add Forward Only Account

Description

Adds a forward only 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 Order
email String Required Email address of user
forwards String Required Comma-separated email addresses

HTTP Method

POST

Example Test URL Request


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

Response

Returns the details of a forward only account addition.

Add User

Description

Adds a user.

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
email String Required Email address of user
passwd String Required Password of user
notification-email String Required Notification email address of user
first-name String Required First name of user
last-name String Required Last name of user
country-code String Required Country Code as per ISO 3166-1 alpha-2
language-code String Required Language Code as per ISO

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/mail/user/add.json?auth-userid=0&api-key=key&order-id=0&[email protected]&passwd=user-password&[email protected]&first-name=firstname&last-name=lastname&country-code=US&language-code=en

Response

Returns the details of user addition.

Getting Reseller Cost Pricing

Description

Gets the Reseller's Cost Price.

Note

It is recommended you cache all pricing information to ensure you do not have to send API queries to the platform. As there are a huge number of products, the accompanying data may cause longer wait time than usual.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
reseller-id Integer Optional Reseller ID of the Reseller whose Cost Price has to be retrieved. By default, Cost Price of the current user will be retrieved.

HTTP Method

GET

Example Test URL Request

https://test.httpapi.com/api/products/reseller-cost-price.json?auth-userid=0&api-key=key

Response

Returns a hash map with the Cost Price for the specified Reseller or the Reseller whose authorization details are used. The response structure will be:

Domain Names (TLDs)

"productkey":
{
"action-name":
{
"tenure-in-years":"price"
}
}

Example:


domcno":
{
"addtransferdomain":
{
"1":"0.0"
},
"restoredomain":
{
"1":"0.0"
},
"addnewdomain":
{
"1":"0.0"
},
"renewdomain":
{
"1":"0.0"
}
}

Web Services


"hosting":
{
"productkey":
{
"bandid":
{
"pricing":
{
"action":0.0,
"ssl":0.0
}
"description":
{
"parameter":value
}
}
}
}

Example:


"hosting":
{
"email_plan":
{
"1":
{
"pricing":
{
"renew":0.0,
"add":0.0
},
"description":
{
"no_of_mail_accounts":5,
"default":false
}
}
},
"websitebuilder_plan":
{
"1":
{
"pricing":
{
"renew":0.0,
"add":0.0
},
"description":
{
"no_of_mail_accounts":1,
"default":true,
"webspace":100,
"noofpages":10
}
}
}
}

Single Domain Linux Hosting


"productkey":
{
"productkey":
{
"bandid":
{
"pricing":
{
"action":0.0,
"ssl":0.0
}
"description":
{
"parameter":value
}
}
}
}

Example:

US Server


"singledomainhostinglinuxus":
{
"singledomainhostinglinuxus":
{
"1":
{
"pricing":
{
"renew":0.0,
"ssl":0.0,
"add":0.0
}
"description":
{
"no_of_mail_accounts":-1,
"default":true,
"bandwidth":-1,
"webspace":-1
}
}
}
}

India Server


"singledomainhostinglinuxin":
{
"singledomainhostinglinuxin":
{
"1":
{
"pricing":
{
"renew":0.0,
"ssl":0.0,
"add":0.0
}
"description":
{
"no_of_mail_accounts":-1,
"default":true,
"bandwidth":-1,
"webspace":-1
}
}
}
}

Single Domain Windows Hosting


"productkey":
{
"productkey":
{
"bandid":
{
"pricing":
{
"action":0.0,
"ssl":0.0
}
"description":
{
"parameter":value
}
}
}
}

Example:

US Server


"singledomainhostingwindowsus":
{
"singledomainhostingwindowsus":
{
"1":
{
"pricing":
{
"renew":0.0,
"ssl":0.0,
"add":0.0
}
"description":
{
"no_of_mail_accounts":-1,
"default":true,
"bandwidth":-1,
"webspace":-1
}
}
}
}

India Server


"singledomainhostingwindowsin":
{
"singledomainhostingwindowsin":
{
"1":
{
"pricing":
{
"renew":0.0,
"ssl":0.0,
"add":0.0
}
"description":
{
"no_of_mail_accounts":-1,
"default":true,
"bandwidth":-1,
"webspace":-1
}
}
}
}

Multi Domain Linux Hosting


"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}

Example:

US Server


"multidomainhosting":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

India Server


"multidomainhostinglinuxin":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Multi Domain Windows Hosting


"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}

Example:

US Server


"multidomainwindowshosting":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

India Server


"multidomainwindowshostingin":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Reseller Linux Hosting


"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}

Example:

US Server


"resellerhosting":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

India Server


"resellerhostinglinuxin":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Reseller Windows Hosting


"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}

Example:

US Server


"resellerwindowshosting":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}