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

Prerequisites:
- Have valid authentication credentials: auth-userid (integer) and api-key (string).
- Know the customer-id (integer) of the suspended customer account to be unsuspended.

Steps:
1) Prepare a POST request to the API endpoint:  
   `https://test.httpapi.com/api/customers/unsuspend.json`  
2) Include the following parameters in the request query or body:  
   - `auth-userid` (Integer): Your authentication user ID (required).  
   - `api-key` (String): Your API key for authentication (required).  
   - `customer-id` (Integer): The ID of the customer account to unsuspend (required).  
   - `reason` (String): Optional explanation for the unsuspension.  
3) Submit the POST request to the API endpoint.
4) Check the response from the API:  
   - A value of `true` indicates the account was successfully unsuspended.  
   - If an error occurs, the response will include a status key with value `ERROR` and an error message explaining the problem.

Summary:
You can unsuspend a suspended customer account using a POST API request with required authentication and the customer ID. The response confirms success or provides error details.

Evaluation Pairs:
Q: What parameters must I include to unsuspend a customer account using the API?  
A: You must include auth-userid, api-key, and customer-id. The reason parameter is optional.

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

Q: How do I know if the unsuspension was successful?  
A: The API returns `true` if successful. If there is an error, a status key with the value `ERROR` and an error message will be returned.

<p>When you want to restore access to a suspended customer account using the API. This article explains required parameters, optional unsuspension reasons, and response details for customer account reactivation.</p>
<div class="region region-content">
<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">Unsuspend Customer Account</span><a href="/help/article/answer/2987#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>Unsuspends a suspended 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 unsuspend.</td></tr><tr><td colspan="1" rowspan="1">reason</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Optional</td><td colspan="1" rowspan="1">Reason for unsuspension of the account. This parameter is not mandatory. </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/unsuspend.json?auth-userid=0&amp;api-key=key&amp;customer-id=0&amp;reason=reason-for-unsuspension</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 restore access to a suspended customer account using the API. This article explains required parameters, optional unsuspension reasons, and response details for customer account reactivation.

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 unsuspend.
reason	String	Optional	Reason for unsuspension of the account. This parameter is not mandatory.