Skip to content

deletequote.md

Latest commit

 

History

History
83 lines (60 loc) · 1.64 KB

deletequote.md

File metadata and controls

83 lines (60 loc) · 1.64 KB

+++ title = "DeleteQuote" toc = true +++

Deletes a quote.

Removes a quote from the system. This cannot be undone

Request Parameters

Parameter Type Description Required
action string "DeleteQuote" Required
quoteid int The quote id to be deleted Required

Response Parameters

Parameter Type Description
result string The result of the operation: success or error
result string success

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' => 'DeleteQuote',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'quoteid' => '1',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

Example Request (Local API)

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

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

Example Response JSON

{
    "result": "error"
}

Error Responses

Possible error condition responses include:

  • Quote ID Not Found

Version History

Version Changelog
1.0 Initial Version