Title: Suspend a Customer Account Using the API
PrimaryCategory: API
Type: Procedural
Tags: suspend, customer account, API, authentication, reason, response
Source UI Terms: auth-userid, api-key, customer-id, reason
Source Reference: Suspend Customer Account - API Documentation

Prerequisites:
- Obtain your API authentication credentials: auth-userid (integer) and api-key (string).
- Identify the customer-id (integer) of the account you want to suspend.
- Prepare a suspension reason message to be visible to the customer.

Steps:
1) Use the HTTP POST method to send a request to the API endpoint:
   `https://test.httpapi.com/api/customers/suspend.json`
2) Include the following required parameters in the query string or request body:
   - auth-userid: Your user ID for API authentication (integer).
   - api-key: Your API key for authentication (string).
   - customer-id: The ID of the customer account to suspend (integer).
   - reason: The suspension reason message visible to the customer (string).
3) Submit the POST request.

Warnings:
- Ensure the reason parameter is clear as it will be visible to the customer on their panel.
- In case of errors, the response will contain a &quot;status&quot; key with the value &quot;ERROR&quot; and an error message.

Summary:
To suspend a customer account using the API, send a POST request with your authentication credentials, the customer ID, and a visible suspension reason. The API will return true if successful or an error status and message if not.

Evaluation Pairs:
Q: What parameters are required to suspend a customer account using the API?
A: You must include auth-userid, api-key, customer-id, and reason parameters in your POST request.

Q: What HTTP method should I use to suspend a customer account?
A: Use the POST method for the suspension request.

Q: How will I know if the suspension was successful?
A: The API returns true if successful; otherwise, it returns a status key with the value ERROR and an error message.

<p>When you want to suspend a customer account using the API. This article explains required parameters, suspension reasons, customer visibility of suspension messages, and response details for account suspension requests.</p>
<div class="region region-content">
<div class="hidden"> </div>
<div class="block block-core block-page-title-block" id="block-twostates-page-title">
<div class="content">
<h1 class="title page-title"><span class="field field--name-title field--type-string field--label-hidden">Suspend Customer Account</span><a href="/help/article/answer/2986#heading_0" target="_blank"></a></h1>
</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 customer account. </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">Authentication Parameter</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">Authentication Parameter</td></tr><tr><td colspan="1" rowspan="1">customer-id</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Customer ID of the customer account which you want to suspend.</td></tr><tr><td colspan="1" rowspan="1">reason</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Reason for suspension of the account. This will be visible to the customer from the panel.</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>https://test.httpapi.com/api/customers/suspend.json?auth-userid=0&amp;api-key=key&amp;customer-id=0&amp;reason=reason-for-suspension</code></p>
<h2><a name="heading_4"></a>Response</h2>
<ul><li>
<p>Returns true if the action is completed. </p>
</li><li>
<p>In case of any errors, a <strong>status</strong> key with value as <em>ERROR</em> along with an error message will be returned.</p>
</li></ul>
</div>
</div>
</div>
</div>
<div class="mychild-topics"> </div>
</div>
<div class="seedetailssection"> </div>

When you want to suspend a customer account using the API. This article explains required parameters, suspension reasons, customer visibility of suspension messages, and response details for account suspension requests.

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.