Login

Reset password

Reset password

An email with an embedded link will be sent to the receipient of the email address

The link will contain a token to be used for resetting the password

post/v1/password/reset

Request body

emailstring email required

the email address of the user requesting the reset password

Example request

{
  "email": "foo@example.com"
}

Response

the request was accepted

Changes

Changed in 4 of the 50 revisions of this API.417

  • dd71433847a616See the full diff
    • the errors/items/ response's property type/format changed from / to object/ for status 400

      response-property-type-changed

    • added the optional property errors/items/errorCode to the response with the 400 status

      response-optional-property-added

    • added the optional property errors/items/errorData to the response with the 400 status

      response-optional-property-added

    • added the optional property errors/items/localisationDetails to the response with the 400 status

      response-optional-property-added

    • added the optional property httpStatusCode to the response with the 400 status

      response-optional-property-added

    • response property errors/items/locationType deprecated

      response-property-deprecated

    • response property errors/items/reasonCode deprecated

      response-property-deprecated

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 1b2abf26b5d621See the full diff
    • the response's body type/format changed from object/ to / for status 400

      response-body-type-changed

    • the errors/items/ response's property type/format changed from object/ to / for status 400

      response-property-type-changed

    • added the new requestParam enum value to the errors/items/locationType response property for the response status 400

      response-property-enum-value-added

    This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 257 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog