Description
Suspends a customer account.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| customer-id | Integer | Required | Customer ID of the customer account which you want to suspend. |
| reason | String | Required | Reason for suspension of the account. This will be visible to the customer from the panel. |
HTTP Method
POST
Example Test URL Request
https://test.httpapi.com/api/customers/suspend.json?auth-userid=0&api-key=key&customer-id=0&reason=reason-for-suspension
Response
-
Returns true if the action is completed.
-
In case of any errors, a status key with value as ERROR along with an error message will be returned.