> For the complete documentation index, see [llms.txt](https://rimplenet.gitbook.io/rimplenet/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://rimplenet.gitbook.io/rimplenet/api-reference/passwords/reset-password.md).

# Reset password

{% hint style="info" %}
**Must have the authorization to use this API**
{% endhint %}

## fire\_email is optional. In a case where it is used, it must be true or false. When it is true, a token is sent to the email address provided and when false, a token is returned in the response.

<mark style="color:blue;">`GET`</mark> `https://example.com/wp-json/rimplenet/v1 /reset-password`

#### Request Body

| Name                                              | Type   | Description                    |
| ------------------------------------------------- | ------ | ------------------------------ |
| email\_address <mark style="color:red;">\*</mark> | String | Email address to receive mail  |
| fire\_address                                     | Bool   | Should be either TRUE or FALSE |

{% tabs %}
{% tab title="200: OK Token address" %}

```php
{
    "status_code": 200,
    "status": true,
    "message": "Token Generated",
    "data": {
        "token_to_reset_password": "dd6c96",
        "mail": false
    }
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
To view request params, click on the arrow (>) at the right-hand side of the endpoint url to expand or collapse
{% endhint %}

**Sample response**

{% tabs %}
{% tab title="200 Ok" %}

```php
{
    "status_code": 200,
    "status": true,
    "message": "Token Generated",
    "data": {
        "token_to_reset_password": "dd6c96",
        "mail": false
    }
}
```

{% endtab %}
{% endtabs %}

<mark style="color:green;">`POST`</mark> `https://example.com/wp-json/rimplenet/v1 /reset-password`

#### Request Body

| Name                                                          | Type       | Description                                                                  |
| ------------------------------------------------------------- | ---------- | ---------------------------------------------------------------------------- |
| email\_address<mark style="color:red;">\*</mark>              | String     | Email address (Required)                                                     |
| new\_password<mark style="color:red;">\*</mark>               | String/int | New intended password                                                        |
| confirm\_new\_password<mark style="color:red;">\*</mark>      | String/int |                                                                              |
| token\_to\_reset\_password <mark style="color:red;">\*</mark> | String/int | Provide token sent to mail or token contained in the GET response from above |

{% tabs %}
{% tab title="200: OK Password Changed successfully" %}

```php
{
    "status_code": 200,
    "status": true,
    "message": "Password Changed Successfully",
    "data": null
}
```

{% endtab %}
{% endtabs %}

​​

{% hint style="info" %}
To view request params, click on the arrow (>) at the right-hand side of the endpoint url to expand or collapse
{% endhint %}

**Sample response**

{% tabs %}
{% tab title="200 Ok" %}

```php
{
    "status_code": 200,
    "status": true,
    "message": "Password Changed Successfully",
    "data": null
}
```

{% endtab %}
{% endtabs %}

​

​

​

​