Suspend reseller

This function suspends a reseller account.

SecurityBasicAuth

Request

user required	string <username> The reseller's username. Example: user=username
disallow	integer Default: 0 Whether to allow only the `root` user to unsuspend the account. `1` — Only the `root` user can unsuspend the account. `0` — The `root` user or the account's owner can unsuspend the account. Enum: 0 1 Example: disallow=0
reason	string The reason for the reseller's suspension. Note: We strongly recommend that you always include a reason for suspension. Example: reason=Nonpayment
reseller-only	integer Default: 0 Whether to suspend only the reseller account. `1` — The function only suspends the reseller account. The function will not suspend the accounts that the reseller account owns. `0` — The function suspends the reseller account and the accounts that it owns. Enum: 0 1 Example: reseller-only=0

Responses

200

HTTP Request was successful.

object

get/suspendreseller

Request samples

whmapi1 --output=jsonpretty \
  suspendreseller \
  user='username'

Response samples

application/json

{"metadata": {"command": "suspendreseller",
"output": {"raw": "string"
},
"reason": "OK",
"result": 1,
"version": 1
}
}