Sends the Register command to the registrar for the domain

Connects to the registrar and attempts to register the domain.

Request Parameters

Parameter Type Description Required
action string “DomainRegister” Required
domainid int The id of the domain to register recommended Optional
domain string The domain name to be registered. This or $domainid is required Optional
idnlanguage string The language code for the domain being registered - will override the input already on the domain. Optional 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' => 'DomainRegister',
            // See
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'domainid' => '1',
            'responsetype' => 'json',
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);

Example Request (Local API)

$command = 'DomainRegister';
$postData = array(
    'domainid' => '1',
$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 Not Found
  • Registrar Error Message
  • Invalid IDN Language. Must be one of: xxx

Version History

Version Changelog
1.0 Initial Version
8.0 Added IDN Language parameter