# API: get Client Automation Settings
# getClientAutomationSettings
Get Client Custom Automation Settings - values returned in overrides
are only those that have been overridden in the client profile. Check setClientAutomationSettings
call for available settings to set/get
# Required parameters
Parameter | Description |
---|---|
id | Client Id |
# Request
GET /admin/api.php?api_id=API_ID&api_key=API_KEY&call=getClientAutomationSettings&id=ID
# PHP Samples
$url = 'http://url_to_hb.com/admin/api.php';
$post = [
'call' => 'getClientAutomationSettings',
'api_id' => $API_ID,
'api_key' => $API_KEY,
'id' => $ID,
];
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
$data = curl_exec($ch);
curl_close($ch);
$return = json_decode($data, true);
print_r($return);
include 'class.hbwrapper.php';
HBWrapper::setAPI('http://url_to_hb.com/admin/api.php','API ID','API Key');
$params = [
'id' => $ID,
];
$return = HBWrapper::singleton()->getClientAutomationSettings($params);
print_r($return);
/* Use this method to access HostBill api from HostBill modules */
$api = new ApiWrapper();
$params = [
'id' => $ID,
];
$return = $api->getClientAutomationSettings($params);
print_r($return);
# Response
{
"success": true,
"overrides": {
"settings": {
"CreditAutoApply": "on",
"DefaultPaymentModule": "631",
"GenerateSeparateInvoices": "off"
},
"settings_enabled": {
"CreditAutoApply": true,
"DefaultPaymentModule": true,
"GenerateSeparateInvoices": true
}
},
"call": "getClientAutomationSettings",
"server_time": 1718361920
}