Actions51
- Client Actions
- Custom API Call Actions
- Domain Actions
- Invoice Actions
- Order Actions
- Product / Service Actions
- System Actions
- Ticket Actions
Client → Update
AI-generatedSummary
Update a client record in WHMCS
Inputs
- clientid (required) — Numeric ID of the client to update; leave 0 to search by email
- updateFields — Collection of fields to update on the client, such as address1, city, email, status, etc.
- customParameters — Additional WHMCS API parameters not covered by the standard fields; names must match the WHMCS API Reference exactly (case-sensitive)
Output shape
object representing the WHMCS API response for the UpdateClient action
Contains result and message fields; if an error occurs and continueOnFail is enabled, an error object may be returned instead
Examples
Example 1: Update client 123's email and set status to Inactive
clientid: 123; updateFields: { email: 'new@example.com', status: 'Inactive' }
Example 2: Update client 456 and add a custom parameter customfields with value 'VIP'
clientid: 456; updateFields: { status: 'Active' }; customParameters: [{ name: 'customfields', value: 'VIP' }]
Example 3: Change client 789's status to Closed
clientid: 789; updateFields: { status: 'Closed' }