UpdateClient

Updates a client with the passed parameters.

Request Parameters

Parameter Type Description Required
action string “UpdateClient” Required
clientid int The ID of the client to update. Optional
clientemail string The email address of the client to update. Either $clientid or $clientemail is required. Optional
firstname string Optional
lastname string Optional
companyname string Optional
email string Optional
address1 string Optional
address2 string Optional
city string Optional
state string Optional
postcode string Optional
country string Two-character ISO country code. Optional
phonenumber string Optional
tax_id string The client Tax ID. Optional
cardtype string Credit card type. Provide the full name: Visa, Mastercard, American Express, etc. Deprecated
cardnum string Credit card number. Deprecated
expdate string Format: MMYY Deprecated
startdate string Format: MMYY (if applicable) Deprecated
issuenumber string Credit card issue number (if applicable). Deprecated
cvv string Credit card CVV number (will not be stored). Deprecated
bankcode string Client Bank Account Code (if applicable). Deprecated
bankacct string Client bank Account number (if applicable). Deprecated
currency int Currency ID from tblcurrencies. Optional
groupid int Client Group ID from tblclientgroups. Optional
customfields string Base64-encoded serialized array of custom field values. Optional
language string Default language setting. Provide the full name: ‘english’, ‘french’, etc. Optional
clientip string IP address of the user. Optional
notes string Admin-only notes. Optional
status string The status. For example, “Active”. Optional
paymentmethod string The default payment method. Optional
email_preferences[general] bool Whether the client should receive general emails. Optional
email_preferences[product] bool Whether the client should receive product emails. Optional
email_preferences[domain] bool Whether the client should receive domain emails. Optional
email_preferences[invoice] bool Whether the client should receive invoice emails. Optional
email_preferences[support] bool Whether the client should receive support emails. Optional
email_preferences[affiliate] bool Whether the client should receive affiliate emails. Optional
marketingoptin bool Set this to ‘true’ to opt the client in to marketing emails. Optional
clearcreditcard bool Set this to ‘true’ to clear the stored credit card details. Optional
skipvalidation bool Set this to ‘true’ to ignore required field validation. Optional
latefeeoveride bool Whether to override the account’s Late Fees setting. Optional
overideduenotices bool Whether to override the account’s Overdue Notices setting. Optional
taxexempt bool Whether the account is exempt from tax collections. Optional
separateinvoices bool Whether to group items that share a due date and payment method into one invoice for the account. Optional
disableautocc bool Whether to enable or disable automatic credit card processing. Optional
overrideautoclose bool Whether to enable or disable automatic credit card processing. 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, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
    http_build_query(
        array(
            'action' => 'UpdateClient',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'clientid' => '1',
            'firstname' => 'John',
            'lastname' => 'Doe',
            'email' => '[email protected]',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

Example Request (Local API)

$command = 'UpdateClient';
$postData = array(
    'clientid' => '1',
    'firstname' => 'John',
    'lastname' => 'Doe',
    'email' => '[email protected]',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

$results = localAPI($command, $postData, $adminUsername);
print_r($results);

Example Response JSON

{
    "result": "success",
    "clientid": "1"
}

Warning Responses

Warning responses are returned when using API functionality that has been removed or marked as deprecated. We suggest following any recommended actions in the warning to ensure future compatibility.

Possible warning messages include:

  • Credit card related parameters are now deprecated and may be removed in a future version. Use AddPayMethod or UpdatePayMethod instead.
  • Credit card related parameters are now deprecated and may be removed in a future version. Use DeletePayMethod instead.

Error Responses

Possible error condition responses include:

  • Client ID Not Found
  • You must have at least one email address enabled to receive domain related notifications as required by ICANN. To disable domain notifications, please create an alternative contact that is set to receive them
  • Duplicate Email Address
  • Multiple Credit Card Pay Methods Found
  • Multiple Bank Account Pay Methods Found

Version History

Version Changelog
1.0 Initial Version
7.8 Credit card related parameters are now deprecated and may be removed in a future version. Use AddPayMethod, DeletePayMethod or UpdatePayMethod instead.
7.10 Added email preferences parameters
8.0 Removed attributes migrated to users: security questions and password