Request a password reset link

POST

/api/auth/password-reset/request

curl --request POST \
  --url https://api.getvespy.com/api/auth/password-reset/request \
  --header 'Content-Type: application/json' \
  --data '{ "email": "hello@example.com" }'

• Production
• Development
• Local

Request Body^required

Media typeapplication/json

object

email

required

string format: email

Example^generated

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

Responses

202

Default Response

Media typeapplication/json

object

status

required

string

Allowed values: accepted

Example

{
  "status": "accepted"
}

400

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}