update_accountsettings()

Update your own account settings.

All API functions Settings

Signature

update_accountsettings(array $parameters): mixed

Parameters

Pass these parameters as KasRequestParams. Every request also requires kas_login, kas_auth_type, and kas_auth_data, as shown in SOAP with PHP.

Name Description Requirement
account_password The KAS password Optional
show_password Show the notice about displaying passwords Optional
logging Access log setting: voll (full), kurz (short), ohneip (without IP addresses), or keine (none) Optional
logage Logs are deleted after this number of days: 1-999 Optional Default: 190
statistic Language of the generated statistics (=/usage), 0 disables them: 0|de|en Optional Default: 0
account_comment The account comment Optional
account_contact_mail The contact email address Optional

PHP example

<?php

// $sessionToken is returned by KasAuth, see SOAP with PHP.
$parameters = [
    'account_comment' => 'new comment',
];

try {
    $client = new SoapClient('https://kasapi.kasserver.com/soap/wsdl/KasApi.wsdl');
    $response = $client->KasApi(json_encode([
        'kas_login' => 'w0123456',
        'kas_auth_type' => 'session',
        'kas_auth_data' => $sessionToken,
        'kas_action' => 'update_accountsettings',
        'KasRequestParams' => $parameters,
    ]));
    print_r($response);
} catch (SoapFault $fault) {
    echo 'Error: ' . $fault->faultstring;
}
Open interactive example

Responses and error codes

  • TRUE the action was carried out
  • in_progress the KAS object is currently being processed
  • nothing_to_do nothing was changed
  • account_comment_syntax_incorrect
  • account_contact_mail_syntax_incorrect
  • account_kas_password_syntax_incorrect
  • logging_syntax_incorrect
  • show_password_syntax_incorrect