Title: Change a Customer Password Using the API  
PrimaryCategory: API  
Type: Procedural  
Tags: change_password, api, customer_account, authentication, request_parameters  
Source UI Terms: auth-userid, api-key, customer-id, new-passwd  
Source Reference: Change a Customer Password Using the API  

---

### Prerequisites:
- Have valid `auth-userid` (Integer) for authentication.
- Have valid `api-key` (String) for authentication.
- Know the `customer-id` (Integer) whose password you want to change.
- Choose the new password (`new-passwd`, String) to set.

### Steps:
1) Prepare an API POST request to the URL:  
   `https://test.httpapi.com/api/customers/v2/change-password.json`
2) Include the following parameters in the query string or POST data:  
   - `auth-userid` (Integer): Your authentication user ID.  
   - `api-key` (String): Your API key for authentication.  
   - `customer-id` (Integer): The ID of the customer account to update.  
   - `new-passwd` (String): The new password for the customer.
3) Send the POST request to the API endpoint.
4) Evaluate the response:  
   - If the response returns `true`, the password change was successful.  
   - If an error occurred, the response contains `&quot;status&quot;: &quot;ERROR&quot;` and an error message.

### Summary:
To change a customer&#39;s password using the API, send a POST request with authentication parameters, customer ID, and the new password. A successful response returns true; otherwise, an error message is provided.

### Evaluation Pairs:

Q: What API method do I use to change a customer&#39;s password?  
A: Use the POST HTTP method to send the request with required parameters.

Q: Which parameters are required to change a customer password via the API?  
A: You must provide `auth-userid`, `api-key`, `customer-id`, and `new-passwd`.

Q: How do I know if the password change was successful?  
A: The API returns `true` if successful; otherwise, it returns an error status with a message.

<p>When you want to change a customer password using the API. This article explains the required parameters and API request details for updating a customer account password.</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">Changing a Customer&#39;s Password</span></h1>
<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>Changes the password for the specified Customer.</p>
<h2><a name="heading_1"></a>Parameters</h2>
<table class="codetable" style="width: 100%;height: 254.676px;"><tbody><tr style="height: 55.0926px;"><th colspan="1" rowspan="1" style="width: 10.1815%;">Name</th><th colspan="1" rowspan="1" style="width: 8.76838%;">Data Type</th><th colspan="1" rowspan="1" style="width: 17.2641%;">Required / Optional</th><th colspan="1" rowspan="1" style="width: 55.9121%;">Description</th></tr><tr style="height: 55.0926px;"><td colspan="1" rowspan="1" style="width: 10.1815%;">auth-userid</td><td colspan="1" rowspan="1" style="width: 8.76838%;">Integer</td><td colspan="1" rowspan="1" style="width: 17.2641%;">Required</td><td colspan="1" rowspan="1" style="width: 55.9121%;">Authentication Parameter</td></tr><tr style="height: 34.3056px;"><td colspan="1" rowspan="1" style="width: 10.1815%;">api-key</td><td colspan="1" rowspan="1" style="width: 8.76838%;">String</td><td colspan="1" rowspan="1" style="width: 17.2641%;">Required</td><td colspan="1" rowspan="1" style="width: 55.9121%;">Authentication Parameter</td></tr><tr style="height: 55.0926px;"><td colspan="1" rowspan="1" style="width: 10.1815%;">customer-id</td><td colspan="1" rowspan="1" style="width: 8.76838%;">Integer</td><td colspan="1" rowspan="1" style="width: 17.2641%;">Required</td><td colspan="1" rowspan="1" style="width: 55.9121%;"><strong>Customer Id</strong> of the Customer whose password needs to be changed</td></tr><tr style="height: 55.0926px;"><td colspan="1" rowspan="1" style="width: 10.1815%;">new-passwd</td><td colspan="1" rowspan="1" style="width: 8.76838%;">String</td><td colspan="1" rowspan="1" style="width: 17.2641%;">Required</td><td colspan="1" rowspan="1" style="width: 55.9121%;">New password</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/v2/change-password.json?auth-userid=0&amp;api-key=key&amp;customer-id=0&amp;new-passwd=password1 </code></p>
<h2><a name="heading_4"></a>Response</h2>
<p>Returns <em>true</em> (Boolean) if the Customer&#39;s password is changed successfully.</p>
<p>In case of any errors, a <strong>status</strong> key with value as <em>ERROR</em> alongwith an error message will be returned.</p>
</div>
</div>
</div>
</div>
<div class="mychild-topics"> </div>
</div>
<div class="seedetailssection"> </div>

When you want to change a customer password using the API. This article explains the required parameters and API request details for updating a customer account password.

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 whose password needs to be changed
new-passwd	String	Required	New password