POST ​/api​/v3​/account​/password

Sends password reset instructions for a username.

Request

Example Request

{
  "username": "billycorgan"
}

Example Parameters

  • username: The user's username.
    • Required: yes
    • Type: string
    • Example: billycorgan

Response

Example Response

{
  "message": "Reset Instructions Sent."
}

Response Parameters

  • message:

    • Required: yes
    • Type: string
    • Example: Reset Instructions Sent.

Response Codes

Successful Response Codes

  • 201: Indicates that the reset instructions were sent.

Failure Response Codes

  • 422: Indicates a username param was not passed

  • 404: Indicates that the username was not found