API Documentation

Everything you must know in one place

namecheap.whoisguard.allot

Allots WhoisGuard privacy protection to a domain.

Example Request

http://api.namecheap.com/xml.response?apiuser=demo&apikey=d41474b94e7d4536baabb074a09c96bd&username=demo&Command=Namecheap.Whoisguard.allot&ClientIp=192.168.1.109&DomainName=domain1.com&whoisguardid=5924316

Request Parameters

Global parameters are not shown here for clarity, but should be present in all requests

Name Type MaxLength Required? Description
WhoisguardId Number 10 Yes The unique WhoisGuardID
DomainName String 70 Yes Domain that you wish to allot WhoisGuard to
ForwardedToEmail String 70 No The email to which you wish to forward your WhoisGuard emails
EnableWG String 5 No Possible Values: True and False
Default Value:False

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<ApiResponse xmlns="http://api.namecheap.com/xml.response" Status="OK">
  <Errors />
  <Warnings />
  <RequestedCommand>namecheap.whoisguard.allot</RequestedCommand>
  <CommandResponse Type="namecheap.whoisguard.allot">
    <WhoisguardAllotResult ID="5924316" DomainName="domain1.com" IsSuccess="true" />
  </CommandResponse>
  <Server>API02</Server>
  <GMTTimeDifference>--5:00</GMTTimeDifference>
  <ExecutionTime>0.832</ExecutionTime>
</ApiResponse>

Response Parameters

Name Description
ID A unique integer value that represents the WhoisGuard subscription.
Domainname The domain name associated with the subscription.
IsSuccess Indicates whether WhoisGuard was allotted successfully.

Error Codes

Specifies the error codes that might be returned from this method

Number Description
2011331 WHOISGUARD ALREADY EXISTS FOR THIS DOMAIN (or) THIS WHOISGUARD ALREADY ASSOCIATED WITH ANOTHER DOMAIN (or) WhoisGuard is not associated with this user (or) WHOISGUARD EXPIRED OR WHOISGUARD IS NOT IN USE
2011369 WhoisGuard forwarded Email address is not valid
2011280 WhoisGuard cannot be alloted/enabled for this domain

Comments

We welcome your comments, questions, corrections and additional information relating to this article. Your comments may take some time to appear. Please be aware that off-topic comments will be deleted.

If you need specific help with your account, feel free to contact our Support Team. Thank you.

Need help? We're always here for you.

× Close