Elep

<h2>Overview</h2>
<span class="lead">
    Sends an email request to reset a users password.
</span>

<h2>Request Arguments</h2>
<table class="table table-hover">
    <thead>
    <tr>
        <th>Name</th>
        <th>Type</th>
        <th>Description</th>
        <th>Required</th>
    </tr>
    </thead>
    <tbody>
    <tr>
        <td>
            email
        </td>
        <td>
            String
        </td>
        <td>
            The email of the user.
        </td>
        <td>
            True
        </td>
    </tr>
    <tr>
        <td>
            username
        </td>
        <td>
            String
        </td>
        <td>
            The username of the user.
        </td>
        <td>
            True
        </td>
    </tr>
    </tbody>
</table>

<h3>Request</h3>
<pre class="pre-scrollable">
http://{site_url}/rest/v10/password/request?email=admin%40sugar.crm&username=admin
</pre>
<strong>Note:</strong> GET endpoint parameters are passed in the form of a query string.

<h2>Response Arguments</h2>
<table class="table table-hover">
    <thead>
    <tr>
        <th>Name</th>
        <th>Type</th>
        <th>Description</th>
    </tr>
    </thead>
    <tbody>
    <tr>
        <td>
            Success
        </td>
        <td>
            boolean
        </td>
        <td>
            Returns the result of sending the email.
        </td>
    </tr>
    </tbody>
</table>

<h3>Response</h3>
<pre class="pre-scrollable">
true
</pre>

<h2>Change Log</h2>
<table class="table table-hover">
    <tr>
        <th>Version</th>
        <th>Change</th>
    </tr>
    <tr>
        <td>
            v10
        </td>
        <td>
            Added <code>/password/request</code> POST endpoint.
        </td>
    </tr>
</table>