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
|
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.
Note
|
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®-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0
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®-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®-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&designated-agent=true
Example Test URL Request for modifying the associated contact for a .FR, .SCOT or .NZ domain name to an EEA contact
https://test.httpapi.com/api/domains/modify-contact.json?auth-userid=0&api-key=key&order-id=0®-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&&attr-name1=tnc&attr-value1=Y
In case of .FR domain names, the tnc parameter is required only if the new contact is of type Organization. For .FR, a contact is of type Organization if a value is passed in the company field. If it is empty, the contact is automatically considered to be of type Individual.
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.