Requests a password reset token for the user account that matches the supplied email address. This token is sent to the email address of the user.

POST

/api/v1/user/reset-password

Authorizations

• Client

Request Body ^required

object

emailAddress

Email address of the user.

string

Example

[email protected]

Responses

204

Password reset token was requested successfully.

400

A list of possible errors for this endpoint.

object

code

required

string

Allowed values: ER001 ER003 ER354 ER800 ER801 ER802 ER803 ER805 ER806 ER999

message

required

string

solution

required

string

Example

{
  "errors": {
    "ER001": {
      "code": "ER001",
      "message": "Email address is invalid.",
      "solution": "Provide a valid email address."
    },
    "ER003": {
      "code": "ER003",
      "message": "No email address provided.",
      "solution": "Provide a valid email address."
    },
    "ER354": {
      "code": "ER354",
      "message": "Failed to request a password reset token",
      "solution": "Try again later, or contact support if problems continue"
    },
    "ER800": {
      "code": "ER800",
      "message": "Authorization token is invalid.",
      "solution": "Provide a valid authorization token."
    },
    "ER801": {
      "code": "ER801",
      "message": "Authorization token has expired.",
      "solution": "Request a new authorization token."
    },
    "ER802": {
      "code": "ER802",
      "message": "Authorization token not found.",
      "solution": "Provide an authorization token."
    },
    "ER803": {
      "code": "ER803",
      "message": "Multiple authorization methods used.",
      "solution": "Use exactly one authorization method."
    },
    "ER805": {
      "code": "ER805",
      "message": "API key is invalid.",
      "solution": "Provide a valid API key."
    },
    "ER806": {
      "code": "ER806",
      "message": "API key not found.",
      "solution": "Provide an API key."
    },
    "ER999": {
      "code": "ER999",
      "message": "A general error has occurred. Please contact our support team.",
      "solution": "Contact our support team."
    }
  }
}