Sends the Toggle ID Protect command to the registrar for the domain

Connects to the registrar and attempts to toggle the ID Protect state

Request Parameters

Parameter Type Description Required
action string “DomainToggleIdProtect” Required
domainid int The id of the domain to toggle ID Protection for Required
idprotect bool Should ID Protection be turned on Optional

Response Parameters

Parameter Type Description
result string The result of the operation: success or error

Example Request (CURL)

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, '');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
            'action' => 'DomainToggleIdProtect',
            // See
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'domainid' => '1',
            'idprotect' => true,
            'responsetype' => 'json',
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);

Example Request (Local API)

$command = 'DomainToggleIdProtect';
$postData = array(
    'domainid' => '1',
    'idprotect' => true,
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

$results = localAPI($command, $postData, $adminUsername);

Example Response JSON

    "result": "success"

Error Responses

Possible error condition responses include:

  • Domain ID Not Found
  • Registrar Error Message

Version History

Version Changelog
1.0 Initial Version