POST
/
auth
/
request-password-reset
Request Reset Password
curl --request POST \
  --url https://scribe-api.puppilot.co/auth/request-password-reset \
  --header 'Content-Type: application/json' \
  --header 'X-API-Version: <x-api-version>' \
  --data '{
  "email": "jsmith@example.com"
}'
{
  "message": "Password reset token sent to the provided email."
}

​
Overview

Request a password reset token to allow the user to securely reset their password.

​
Request Body

  • email (string) - User’s email address.

​
Example Request

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

Headers

​
X-API-Version
string
required

API versioning is required. Include the header X-API-Version with current version value in all requests.

Example:

"v1"

Body

application/json

Response

200 - application/json

The response is of type object.