Title: Suspend Multiple Business or Enterprise Email Users Using the API
PrimaryCategory: Business &amp; Enterprise Email
Type: Procedural
Tags: suspend, bulk, api, email_users, business_email, enterprise_email
Source UI Terms: auth-userid, api-key, order-id, emails
Source Reference: Suspend Multiple Business or Enterprise Email Users Using the API

Prerequisites:
- You must have your Live Account Reseller Id.
- You must have a valid API key.
- You must know the Order ID associated with the Domain Registration, Email Hosting, or other relevant order.
- You must have a list of email addresses to suspend, formatted as a comma-separated string.

Steps:
1) Prepare a POST request to the API endpoint: `https://test.httpapi.com/api/mail/users/suspend.json`.
2) Include the following parameters in the query string:
   - `auth-userid`: Your Live Account Reseller Id (Integer, required).
   - `api-key`: Your API authentication key (String, required).
   - `order-id`: The relevant Order ID for your email hosting service (Integer, required).
   - `emails`: Comma-separated email addresses of users to suspend (String, required).
3) Send the POST request to suspend the listed users.
4) Check the API response for the status.
   - If suspension is successful, the status will be `&quot;SUCCESS&quot;`.

Warnings:
- Ensure all email addresses are correctly formatted and separated by commas.
- Authentication failure or invalid parameters will cause the suspension to fail.

Summary:
You can suspend multiple Business or Enterprise Email users at once using a POST API call by providing your reseller ID, API key, order ID, and a comma-separated list of user email addresses. A successful response returns a &quot;SUCCESS&quot; status.

Evaluation Pairs:
Q: What parameters are required to suspend multiple email users using the API?
A: You must provide auth-userid (Reseller Id), api-key, order-id (relevant order), and a comma-separated string of emails.

Q: What HTTP method is used to suspend multiple Business or Enterprise Email users?
A: The POST method is used.

Q: What indicates that the suspension of users was successful in the API response?
A: The API response will return the status &quot;SUCCESS&quot;.

<p>When you want to suspend multiple Business Email or Enterprise Email users using the API. This article explains required parameters, bulk suspension handling, and response details for suspending multiple email account users.</p>
<div class="region region-content">
<div class="block block-core block-page-title-block" id="block-twostates-page-title">
<div class="content">
<div id="toc" style="display: block;">
<div id="toc_content">
<p> </p>
</div>
</div>
</div>
</div>
<div class="node__content clearfix">
<div class="layout layout--onecol">
<div class="layout__region layout__region--content">
<div class="clearfix text-formatted field field--name-body field--type-text-with-summary field--label-hidden field__item">
<h2><a name="heading_0"></a>Description</h2>
<p>Suspends a list of users.</p>
<h2><a name="heading_1"></a>Parameters</h2>
<table class="codetable"><tbody><tr><th colspan="1" rowspan="1">Name</th><th colspan="1" rowspan="1">Data Type</th><th colspan="1" rowspan="1">Required / Optional</th><th colspan="1" rowspan="1">Description</th></tr><tr><td colspan="1" rowspan="1">auth-userid</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Your Live Account Reseller Id</td></tr><tr><td colspan="1" rowspan="1">api-key</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">An alphanumeric code that can be used to authenticate your API calls</td></tr><tr><td colspan="1" rowspan="1">order-id</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Order ID of the Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order</td></tr><tr><td colspan="1" rowspan="1">emails</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Comma-separated email addresses of users</td></tr></tbody></table>
<h2><a name="heading_2"></a>HTTP Method</h2>
<p>POST</p>
<h2><a name="heading_3"></a>Example Test URL Request</h2>
<p><code><br>  https://test.httpapi.com/api/mail/users/suspend.json?auth-userid=0&amp;api-key=key&amp;order-id=0&amp;emails=username1@domainname.com,username2@domainname.com<br> </code></p>
<h2><a name="heading_4"></a>Response</h2>
<p>Returns &quot;SUCCESS&quot; as the status if users suspended successfully.</p>
</div>
</div>
</div>
</div>
<div class="mychild-topics"> </div>
</div>
<div class="seedetailssection"> </div>

When you want to suspend multiple Business Email or Enterprise Email users using the API. This article explains required parameters, bulk suspension handling, and response details for suspending multiple email account users.

Name	Data Type	Required / Optional	Description
auth-userid	Integer	Required	Your Live Account Reseller Id
api-key	String	Required	An alphanumeric code that can be used to authenticate your API calls
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