Deletes a contact.

Removes contact record. This action cannot be undone.

Request Parameters

Parameter Type Description Required
action string “DeleteContact” Required
contactid int The contact id to be deleted Required

Response Parameters

Parameter Type Description
result string The result of the operation: success or error
contactid int The contact id that was deleted

Example Request (CURL)

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, '');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
            'action' => 'DeleteContact',
            // See
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'contactid' => '1',
            'responsetype' => 'json',
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);

Example Request (Local API)

$command = 'DeleteContact';
$postData = array(
    'contactid' => '1',
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

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

Example Response JSON

    "result": "success",
    "contactid": "1"

Error Responses

Possible error condition responses include:

  • Contact ID Not Found

Version History

Version Changelog
1.0 Initial Version