reseller

is added when reseller has a customer specific business

Contacts

Note

It is recommended, that you read TLD and their Contacts specific information, prior to visiting the below-mentioned
links. See details

Add Contact

Adds a Contact using the details provided for the specified type.

Modify Contact Details

Modifies the details of the specified Contact.

Get Contact Details

Gets all the Contact Details for the specified Contact.

Search Contacts

Gets the list of Contact Details which matches the Search criteria.

Get Default Contact

Gets the default Contact for the specified Customer.

Associate Extra Details

Associates extra details with the Contact, which are mandatory to register .US, .COOP, .ASIA domain names.

Delete

Deletes the specified Contact.

Add .COOP Sponsor

Adds a Sponsor for the specified .COOP domain name Customer.

Get Sponsors

Gets a list of system-default Sponsors and Sponsors of the specified Customer.

Getting a Customer's Default Name Servers

Description

Gets the default Name Servers of the specified Customer.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
customer-id Integer Required The Customer for whom you want to fetch the default Name Servers.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/domains/customer-default-ns.json?auth-userid=0&api-key=key&customer-id=0

Response

Returns the Default Name Servers (Array of Strings) of the Customer.

Releasing a .UK Domain Name

Description

Releases (transfers out) the specified .UK domain name to the specified Registrar.

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 which you want to release (transfer out)
new-tag String Required

Tag of the new Registrar. For a two character tag, it is necessary to prepend the tag with a # character.

Example: The tag VI needs to be mentioned as #VI.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/uk/release.json?auth-userid=0&api-key=key&order-id=0&new-tag=newregistrartag

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the Domain Registration Order (entityid)

  • Description of the Domain Release Action (actiontypedesc)

  • Action ID of the Domain Release Action (eaqid)

  • Domain Release Action Status (actionstatus)

  • Description of the Domain Release Action Status (actionstatusdesc)

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

Modifying a Child Name Server IP Address

Description

Modifies the IP address associated with the specified Child Name Server of 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 whose Child Name Server IP you want to change.
cns String Required Name of the Child Name Server whose IP you want to change.
old-ip String Required Currently associated IP address with the specified Child Name Server.
new-ip String Required New IP address that you want to associate with the specified Child Name Server.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/modify-cns-ip.json?auth-userid=0&api-key=key&order-id=0&cns=ns1.domain.com&old-ip=0.0.0.0&new-ip=1.1.1.1

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 Child Name Server IP Modification Action (actiontypedesc)

  • Action ID of the Child Name Server IP Modification Action (eaqid)

  • Child Name Server IP Modification Action Status (actionstatus)

  • Description of the Child Name Server IP Modification Action Status (actionstatusdesc)

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

Modifying Child Name Server Host Name

Description

Modifies the Host Name of the Child Name Server 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 whose Child Name Server you want to change.
old-cns String Required Current Child Name Server of the specified Order.
new-cns String Required New Child Name Server that you want to associate with the Order.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/modify-cns-name.json?auth-userid=0&api-key=key&order-id=0&old-cns=ns1.domain.com&new-cns=ns2.domain.com

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 Child Name Server Host Name Modification Action (actiontypedesc)

  • Action ID of the Child Name Server Host Name Modification Action (eaqid)

  • Child Name Server Host Name Modification Action Status (actionstatus)

  • Description of the Child Name Server Host Name Modification Action Status (actionstatusdesc)

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

Adding Child Name Servers

Description

Adds Child Name Servers 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 want to add the Child Name Servers.
cns String Required Child Name Servers name that you want to add.
ip Array of Strings Required IP addresses that you want to associate with the Child Name Servers.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/add-cns.json?auth-userid=0&api-key=key&order-id=0&cns=ns1.domain.com&ip=0.0.0.0&ip=1.1.1.1

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 Child Name Server Addition Action (actiontypedesc)

  • Action ID of the Child Name Server Addition Action (eaqid)

  • Child Name Server Addition Action Status (actionstatus)

  • Description of the Child Name Server Addition Action Status (actionstatusdesc)

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

Modifying the Auth-Code

Description

Modifies the Auth-Code of 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 whose auth-code you want to modify.
auth-code String Required New auth-code.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/modify-auth-code.json?auth-userid=0&api-key=key&order-id=0&auth-code=authcode

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 Auth-Code Modification Action (actiontypedesc)

  • Action ID of the Auth-Code Modification Action (eaqid)

  • Auth-Code Modification Action Status (actionstatus)

  • Description of the Auth-Code Modification Action Status (actionstatusdesc)

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

Modifying the Privacy Protection Status

Description

Changes the Privacy Protection status of 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 whose privacy protection you want to change.
protect-privacy Boolean Required Enable / Disable Privacy Protection service. Possible values are: true or false.
reason String Required The reason to enable / disable Privacy Protection.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/modify-privacy-protection.json?auth-userid=0&api-key=key&order-id=0&protect-privacy=true&reason=somereason

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 Privacy Protection Modification Action (actiontypedesc)

  • Action ID of the Privacy Protection Modification Action (eaqid)

  • Privacy Protection Modification Action Status (actionstatus)

  • Description of the Privacy Protection Modification Action Status (actionstatusdesc)

  • Invoice ID of the Privacy Protection Purchase Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (sellingamount)

  • Unutilized Transaction Amount in the Selling Currency (unutilisedsellingamount)

Note

invoiceid, sellingcurrencysymbol, sellingamount, unutilisedsellingamount and customerid will be returned even if the Selling Price for Privacy Protection is set to zero, since a zero priced Invoice will be raised while enabling Privacy protection.

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

Modifying Contacts

Description

Modifies the Contacts of 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 whose contact association you want to modify.
reg-contact-id Integer Required The Contact that you want to use as the new Registrant Contact.
admin-contact-id Integer Required The Contact that you want to use as the new Admin Contact.
tech-contact-id Integer Required The Contact that you want to use as the new Technical Contact.
billing-contact-id Integer Required The Contact that you want to use as the new Billing Contact.
sixty-day-lock-optout Boolean Optional Pass this parameter if you want to opt-out of 60 day lock placed after Registrant Contact change is completed

Note
  • Applicable only for GTLDs and if Registrar is opted-in for IRTP
  • Authorized User: Reseller
designated-agent Boolean Optional Pass this parameter as TRUE if you want to opt for Designated Agent. By default this parameter is set to FALSE
attr-name Map[name] Required Mapping key of the extra details to be associated for the specified Contact. Refer the description of attr-value.
attr-value Map[value] Required

Mapping value of the extra details required to modify contact of a domain name. This together with the attr-name shall contain the extra details.

  • To Skip IRTP Process:
    attr-name1=skipIRTP&attr-value1=true
Note
  • Applicable only for GTLDs and if Registrar is opted-in for IRTP
  • Authorized User: Registrar of the domain name

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/modify-contact.json?auth-userid=0&api-key=key&order-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0

Example Test URL Request for Skip IRTP Process


https://test.httpapi.com/api/domains/modify-contact.json?auth-userid=0&api-key=key&order-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&attr-name1=skipIRTP&attr-value1=true

Example Test URL Request for Opt-Out of 60 day lock that is applied post Registrant Change


https://test.httpapi.com/api/domains/modify-contact.json?auth-userid=0&api-key=key&order-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&sixty-day-lock-optout=true

Example Test URL Request for Applying Designated Agent


https://test.httpapi.com/api/domains/modify-contact.json?auth-userid=0&api-key=key&order-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&designated-agent=true

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 Contact Modification Action (actiontypedesc)

  • Action ID of the Contact Modification Action (eaqid)

  • Contact Modification Action Status (actionstatus)

  • Description of the Contact Modification Action Status (actionstatusdesc)

  • IRTP Status (irtp_status)

  • Status of Losing FOA (losing-foa-status)

  • Gaining Contact Info (gaining-contact-info)

    • Organization (organization)

    • Name (name)

    • Contact ID (id)

    • Email (email)

  • Status of Gaining FOA (gaining-foa-status)

  • FOA Expiry (expiry)

  • Message (message)

  • Status of Sixty Day Lock (sixty-day-lock-status)

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

Modifying Name Servers

Description

Modifies the Name Servers of 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 whose Name Servers you want to modify.
ns Array of Strings Required New Name Servers.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/modify-ns.json?auth-userid=0&api-key=key&order-id=0&ns=ns1.domain.asia&ns=ns2.domain.asia

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 Name Server Modification Action (actiontypedesc)

  • Action ID of the Name Server Modification Action (eaqid)

  • Name Server Modification Action Status (actionstatus)

  • Description of the Name Server Modification Action Status (actionstatusdesc)

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

Subscribe to reseller