Activates a given module.
| Parameter | Type | Description | Required |
|---|---|---|---|
| action | string | "UpdateModuleConfiguration" | Required |
| moduleType | string | The module type to be activated | Required |
| moduleName | string | The module name to be activated | Required |
| parameters | array | An array of configuration parameters to set for the given module. Use GetModuleConfigurationParameters to obtain a list of fields for a given module. | Optional |
| Parameter | Type | Description |
|---|---|---|
| result | string | The result of the operation: success or error |
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
http_build_query(
array(
'action' => 'UpdateModuleConfiguration',
// See https://developers.whmcs.com/api/authentication
'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
'password' => 'SECRET_OR_HASHED_PASSWORD',
'moduleType' => 'gateway',
'moduleName' => 'paypal',
'parameters' => array('email' => '[email protected]', 'forcesubscriptions' => true),
'responsetype' => 'json',
)
)
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);$command = 'UpdateModuleConfiguration';
$postData = array(
'moduleType' => 'gateway',
'moduleName' => 'paypal',
'parameters' => array('email' => '[email protected]', 'forcesubscriptions' => true),
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later
$results = localAPI($command, $postData, $adminUsername);
print_r($results);{
"result": "success"
}Possible error condition responses include:
- Invalid module type provided. Supported module types include: xxx
- Invalid module name provided.
- Module activation not supported by module type.
- Module Configuration Update Failed: xxx
- An unexpected error occurred: xxx
| Version | Changelog |
|---|---|
| 7.0.0-beta.1 | Initial Version |