7.4. Request an account password reset.
GET SendPasswordReset
Description: Request to reset your password using an emailed link. Normally used if a password is lost.
API Usage: This endpoint uses zero API calls. Please refer to section 8.2 for more details on API rate limits.
GET Sample Request:
GET https://[server]/SendPasswordReset?Email=myself@mycompany.com
| Parameter | Type | Notes |
| String | The subscriber’s email address to which the
account
is registered. The password reset email will be sent to this address. |
- If the account is inactive an email will be automatically sent to the registered email address.
- Even if the requested email address is unknown a 200 “OK” message is returned for security reasons.
Response Parameters
| Parameter | Type | Mandatory | Description | |
|---|---|---|---|---|
| 1 | ServerDateTime | String | Yes | The server UTC date and time as an ISO 8601 string. |
| 2 | TimeStamp | Float | Yes | The server date and time as a Julian date. |
| 3 | ExecutionTime | Float | Yes | The number of milliseconds taken to process the request. |
| 4 | Result | [Object] | No* | A Result object as described below. |
| 5 | Errors | [Object] | No* | An 'Errors' object as described below. |
On success a Result object is returned; otherwise, an 'Errors' object is returned.
Result Object
| Field name | Type | Mandatory | Description | |
|---|---|---|---|---|
| 1 | Status | Integer | Yes | HTTP status code. Status is 200 for OK/success. |
| 2 | Detail | String | Yes | Description
of
the status message. Status result of 200 returns “OK” in Detail. |
Errors Object
| Parameter | Type | Description | |
|---|---|---|---|
| 1 | Status | Integer | HTTP status code. |
| 2 | Detail | String | Description of the status code above. |
Possible Status codes in the 'Errors' object
| Code | Description |
|---|---|
| 405 | Method [request] not allowed. |
| 429 |
Too many requests have
been made to reset a
password.
|
| 500 | Server may be down for maintenance. |
This is not an exhaustive list and additional error codes may be returned. The Errors object Detail field will return request specific error information.
Possible HTTP response codes
This endpoint returns 200 for
success.
You can get HTTP client network errors or server
errors from any API request. You should check
with your network or IT colleagues in case the issue is
a
local one.
All server generated errors will return an
'Errors'
object that will give specific details about the error.
A full list of HTTP codes and their meanings is
available here,
Success and fail examples
Sample Request:
https://[server]/SendPasswordReset?Email=myself@mycompany.com