Platform API reference

Platform API · Authentication

post/v1/auth/password/request-reset

Request a password reset email. Neither the response nor its timing reveals whether the email matched an account.

Request body

email*string

Email address to send reset token

Example: "user@example.com"

Response · 204

Reset request accepted. Identical whether or not the email matched an account — in status, body, cost, and in what the server is left doing afterwards (see PasswordService.requestPasswordReset). Accepted is not delivered: if the address matched an account the mail was handed to the broker, but a broker outage is logged server-side and still answers 204, so never treat this status as proof an email was sent.

Example

Request

POST https://api.platform-auth.productcraft.co/v1/auth/password/request-reset
Content-Type: application/json

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