WHMCS icon

WHMCS

Interact with the WHMCS billing & automation API

Client → Delete

AI-generated

Summary

Delete a client record in WHMCS

Inputs

  • clientid (required) — Numeric ID of the client to delete; use 0 to look up by email if needed
  • customParameters — Additional WHMCS API parameters not covered by other fields; name must match the API reference exactly

Output shape

A JSON object containing the WHMCS DeleteClient API response (e.g., success status or error details)

The response may include a status field and message; errors are raised unless continueOnFail is enabled

Examples

Example 1: Delete client with ID 42

resource: Client, operation: Delete, clientid: 42

Example 2: Delete client by email using customParameters

resource: Client, operation: Delete, clientid: 0, customParameters: {"parameter":[{"name":"email","value":"user@example.com"}]}

Links

Discussion