reseller

is added when reseller has a customer specific business

Check Availability - Sunrise

Description

Checks the availability of the specified Domain Name(s) in the Sunrise Phase.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
domainname String Required Domain Name that you need to check the availability for in the Sunrise period
tld Array of Strings Required TLD(s) for which the Domain Name availability needs to be checked
smd String Required Pass the content of the smd file

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/domains/available-sunrise.xml?auth-userid=0&api-key=key&domainname=domain1&tld=bike&smd=<smd_file_content>

Response

Returns a hash map containing Domain Name availability status for the requested TLDs:

  • available - Domain Name available for registration

  • regthroughus - Domain Name currently registered through the Registrar whose connection is being used to check the availability of the Domain Name

  • regthroughothers - Domain Name currently registered through a Registrar other than the one whose connection is being used to check the availability of the Domain Name. If you wish to manage such a Domain Name through your Reseller Account, you may pass a Domain Transfer API call. See details

  • unknown - returned, if for some reason, the Registry connections are not available. You should ideally re-check the Domain Name availability after some time.

Fetch Wishlist TLDs based on Category

Description

Fetches the TLDs for the specified Category.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
category String optional The Category for which the TLDs are to be fetched. Values can be adult, arts and media, beauty and fashion, business and commerce, education, finance, food and drink, generic, geo cultural, government and politics, health, idn, news and information, novelty, people and lifestyle, real estate, religion, services, sports and games, technology or travel.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/domains/preordering/fetchtldlist.xml?auth-userid=0&api-key=key&category=services

Response

Returns a hash map containing the below details:

  • Fetch TLDs Action Status (status)

  • Fetch TLDs Action Status Description (status_description)

  • Fetched TLDs Information (response_value)

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

Fetch Wishlist

Description

Fetches the Wishlist.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
customerid Integer Optional Customer ID of the Customer for whom the Wishlist is to be fetched
resellerid Integer Optional Reseller ID of the Reseller for whom the Wishlist is to be fetched
domain Array of Strings Optional Domain Name(s) for which the Wishlist is to be fetched
tld Array of Strings Optional TLD(s) for which the Wishlist is to be fetched
creation-date-start String Optional UNIX TimeStamp for listing of Wishlist entries whose Creation Date is greater than creation-date-start
creation-date-end String Optional UNIX TimeStamp for listing of Wishlist entries whose Creation Date is less than creation-date-end
no-of-records Integer Required Number of records to be returned
page-no Integer Required Page number for which records are required

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/domains/preordering/fetch.xml?auth-userid=0&api-key=key&no-of-records=10&page-no=1

Response

Returns a hash map containing the below details:

  • Fetch Wishlist Action Status (status)

  • Fetch Wishlist Action Status Description (status_description)

  • Wishlist Details (response_value)

    • Domain Name (domainname)

    • TLD associated with the Domain Name (tld)

    • Category under which the TLD is included (category)

    • Wishlist Entry Creation Time (creation_time)

    • Customer ID of the Customer under whom the Wishlist exists (customerid)

    • Reseller ID of the Reseller under whom the Wishlist exists (resellerid)

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

Delete Domain Names from Wishlist

Description

Deletes the specified Domain Name(s) from the Wishlist.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
customerid Integer Required Customer ID of the Customer for whom you wish to delete the Wishlist entry
domain Array of Strings Required Domain Name(s) which need to be deleted from the Wishlist

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/preordering/delete.xml?auth-userid=0&api-key=key&customerid=0&domain=domain1.ads

Response

Returns a hash map containing the below details:

  • Wishlist Entry Deletion Action Status (status)

  • Wishlist Entry Deletion Action Status Description (status_description)

  • Invalid Domain Name(s) (invalid_domains)

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

Add Domain Names to Wishlist

Description

Adds the specified Domain Name(s) to the Wishlist.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
customerid Integer Required Customer ID of the Customer for whom the Wishlist needs to be created / updated
domain Array of Strings Required Domain Name(s) which need to be added to the Wishlist

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/preordering/add.xml?auth-userid=0&api-key=key&customerid=0&domain=domain1.ads

Response

Returns a hash map containing the below details:

  • Wishlist Create / Update Action Status (status)

  • Wishlist Create / Update Action Status Description (status_description)

  • Invalid Domain Name(s) (invalid_domains)

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

Resend Registrant Contact Email Address Verification Email

Description

Resends the verification email to the Registrant Contact Email Address for the specified Domain Registration 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 Order for which you wish to resend the verification email

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/raa/resend-verification.xml?auth-userid=0&api-key=key&order-id=0

Response

Returns true (Boolean) if the action is executed successfully; false otherwise.

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

Check Availability - Premium Domains

Description

Returns a list of Aftermarket Premium domain names based on the specified keyword. This method only returns names available on the secondary market, and not those premium names that are offered directly by any Registry for new registration.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
key-word String Required Word or phrase (please enter the phrase without spaces) for which premium search is requested
tlds Array of Strings Required Domain name extensions (TLDs) you want to search in See details
price-high Integer Optional Maximum price (in Reseller's Selling Currency) upto which domain names must be suggested
price-low Integer Optional Minimum price (in Reseller's Selling Currency) for which domain names must be suggested
no-of-results Integer Optional Number of results to be returned

HTTP Method

GET

Example Test URL Request

https://test.httpapi.com/api/domains/premium/available.xml?auth-userid=0&api-key=key&key-word=domain&tlds=com&tlds=net&tlds=org&price-high=10000&no-of-results=10

Response

Returns a hash map with a list of Aftermarket Premium domain names and the price for each of them.

Get Number Of Users

Description

Gets the number of users per email type categories.

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 Order

HTTP Method

GET

Example Test URL Request


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

Response

Returns the number of users per email type categories.

Subscribe to reseller