Delete relationship between user and client.

Request Parameters

Parameter Type Description Required
action string “DeleteUserClient” Required
user_id int The id of the user to remove from the client Required
client_id int The id of the client to remove the user from 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' => 'DeleteUserClient',
            // See
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'user_id' => '1',
            'client_id' => '1',
            'responsetype' => 'json',
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);

Example Request (Local API)

$command = 'DeleteUserClient';
$postData = array(
    'user_id' => '1',
    'client_id' => '1',
$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:

  • Invalid user id
  • Invalid client id
  • User is not associated with client
  • You cannot remove the account owner

Version History

Version Changelog
8.0.0 Initial Version