Skip to content

Request password reset

Request

Request that a password reset code be sent to the provided email address, if it belongs to a registered user.

Security
SessionKey(Required scopes: public)
Bodyapplication/json
emailstring

Email address to which a password reset code will be sent.

curl -i -X POST \
  https://docs.ticketingevents.com/_mock/openapi/resets \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "email": "marvin.milk@usmc.gov"
  }'

Responses

A password reset code was generated and sent to the provided email address, if it belongs to a registered user.

Bodyapplication/json
selfstring, (uri)

URI of the reset request resource

emailstring

Email addresss to which the password reset code was sent.

statusstring

Current status of the password reset request.

Enum:"Pending""Completed""Expired"
Response
{
  "self": "/resets/16947291161016",
  "email": "marvin.milk@usmc.gov",
  "status": "Pending"
}