Description
Suspends a list of users.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| order-id | Integer | Required | Order ID of the Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order |
| emails | String | Required | Comma-separated email addresses of users |
HTTP Method
POST
Example Test URL Request
https://test.httpapi.com/api/mail/users/suspend.json?auth-userid=0&api-key=key&order-id=0&emails=username1@domainname.com,username2@domainname.com
Response
Returns "SUCCESS" as the status if users suspended successfully.