Title: Suspend a Business or Enterprise Email User Using the API  
PrimaryCategory: Business &amp; Enterprise Email  
Type: Procedural  
Tags: API, suspend user, email user, business email, enterprise email  
Source UI Terms: auth-userid, api-key, order-id, email  
Source Reference: Suspend a Business or Enterprise Email User Using the API

---

### Procedural

Prerequisites:
- Obtain your Live Account Reseller ID.
- Have your API key ready.
- Know the Order ID for the related service (Domain Registration, Email Hosting, etc.).
- Have the email address of the user to suspend.

Steps:
1) Use the HTTP POST method.
2) Send a request to the API endpoint:  
   `https://test.httpapi.com/api/mail/user/suspend.json`
3) 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 order ID associated with the email service (Integer, required)
   - `email`: The email address of the user to be suspended (String, required)
4) Send the request.
5) Check the API response for status:
   - If the response returns `&quot;SUCCESS&quot;`, the user has been suspended successfully.

Warnings:
- Ensure all required parameters are included to avoid request failure.
- The API key should be kept secure to prevent unauthorized access.

Summary:
To suspend a Business or Enterprise Email user using the API, send a POST request with your reseller ID, API key, order ID, and the user&#39;s email address. A successful suspension returns a &quot;SUCCESS&quot; status.

Evaluation Pairs:
Q: What parameters are required to suspend an email user using the API?  
A: You must provide auth-userid (reseller ID), api-key, order-id, and the email address of the user.

Q: What HTTP method is used to suspend a Business or Enterprise Email user via the API?  
A: The HTTP POST method is used.

Q: How do you confirm that the user was suspended successfully?  
A: The API response returns a status of &quot;SUCCESS&quot; when the suspension is successful.

<p>When you want to suspend a Business Email or Enterprise Email user using the API. This article explains required parameters and response details for suspending an email account user.</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 user.</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">email</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Email address of user</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/user/suspend.json?auth-userid=0&amp;api-key=key&amp;order-id=0&amp;email=username@domainname.com<br> </code></p>
<h2><a name="heading_4"></a>Response</h2>
<p>Returns &quot;SUCCESS&quot; as the status if a user suspended successfully.</p>
</div>
</div>
</div>
</div>
<div class="mychild-topics"> </div>
</div>
<div class="seedetailssection"> </div>

When you want to suspend a Business Email or Enterprise Email user using the API. This article explains required parameters and response details for suspending an email account user.

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
email	String	Required	Email address of user