WHMCS icon

WHMCS

Interact with the WHMCS billing & automation API

Custom API Call → Execute API Action

AI-generated

Summary

Execute a WHMCS custom API action

Inputs

  • action (required) — Exact WHMCS API action name (case-sensitive) to invoke.
  • parameters — JSON object of action parameters; keys must match the WHMCS API Reference and are merged with automatically added identifier, secret and responsetype.

Output shape

JSON object containing the raw WHMCS API response for the executed action

Response shape varies by action; on error an exception is thrown unless continueOnFail is enabled, in which case an error message is returned in the JSON payload.

Examples

Example 1: Retrieve a client's details

Set Action to "GetClientsDetails" and optionally add Parameters such as {"clientid": 42}

Example 2: Create a new client

Set Action to "AddClient" and provide Parameters with required fields like {"firstname": "John", "lastname": "Doe", "email": "john@example.com"}

Example 3: List client domains

Set Action to "GetClientsDomains"; no extra parameters required.

Links

Discussion