Runs a custom module action for a given service.

Request Parameters

Parameter Type Description Required
action string “ModuleCustom” Required
serviceid int The service ID to run the action for Required
func_name string The name of the custom function to run Required

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' => 'ModuleCustom',
            // See
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'serviceid' => '1',
            'func_name' => 'reboot',
            'responsetype' => 'json',
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);

Example Request (Local API)

$command = 'ModuleCustom';
$postData = array(
    'serviceid' => '1',
    'func_name' => 'reboot',
$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:

  • Service ID is required
  • Service ID not found
  • Service not assigned to a module
  • Server response message

Version History

Version Changelog
1.0 Initial Version
7.7 Renamed accountid parameter to serviceid. Backwards compatibility preserved for accountid.