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.
otp Integer Optional OTP to authenticate the request
2fa-type String Optional Type of 2FA authentication

  • email: For authentication via email

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

 

Example Test URL Request for OTP authentication

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

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.