customers.php¶

Customer management module for handling ACL updates, order status synchronization, and customer data operations

API Methods¶

Method	Action	Description
`set_order_status`	set order status	Updates the status of a WHMCS order associated with the customer.
`update_acl`	update IP ACL	Updates the IP Access Control List (ACL) for a specific customer. If the provided list is empty, existing tags are removed.

customers/update_acl¶

Updates the IP Access Control List (ACL) for a specific customer. If the provided list is empty, existing tags are removed.

HTTP method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `update_acl`
token	✅	string	Authorization token
id	✅	integer	Customer ID
ips	✅	string	Space-separated list of IP addresses to allow. If empty, the ACL is cleared.

Request example

curl -s "https://invapi.hostkey.com/customers.php" -X POST \
--data "action=update_acl" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE" \
--data "ips=VALUE"

Success response example

{
"result": "OK"
}

Error examples

{
"code": -1,
"message": "invalid customer id"
}

customers/set_order_status¶

Updates the status of a WHMCS order associated with the customer.

HTTP method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `set_order_status`
token	✅	string	Authorization token
id	✅	integer	Customer ID
params[status]	✅	string	The new status for the order.
status	✅	string	Параметр `status`
location	❌	string	The physical or logical location for the order status update.

Request example

curl -s "https://invapi.hostkey.com/customers.php" -X POST \
--data "action=set_order_status" \
--data "token=VALUE" \
--data "id=VALUE" \
--data "params[status]=VALUE" \
--data "status=VALUE"

Success response example

{
"result": "OK",
"action": "set_order_status"
}

Error examples

{
"code": -1,
"message": "Error during status update"
}