Request a password reset email

Request

Request a password reset email for the account with the supplied email address. The response status and body are identical whether or not an account exists for the email; clients must not treat the success response as confirmation that an account exists.

Headers

EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value:2

Bodyapplication/jsonrequired

emailstring, (email)required

The email address of the account to send a reset link to.

curl -i -X POST \
  https://developers.ev.energy/_mock/ev.energy-api-v2/auth/password_reset \
  -H 'Content-Type: application/json' \
  -H 'EvEnergy-Version: 2' \
  -d '{
    "email": "user@example.com"
  }'

Responses

Reset email request accepted.

Headers

EvEnergy-Versionnumber

Indicates the version of the API that generated this response. If EvEnergy-Version was not specified in the request, this will be your OAuth application's default version.

Value:2

X-RateLimit-Limitnumber

The maximum number of requests that can be made to this endpoint per hour. Defaults to 1000 but may vary per client.

Default:1000

X-RateLimit-Remainingnumber

The number of requests remaining until this client's rate limit is reached.

Default:999

RetryAfternumber

The number of seconds until this client's requests will not be rate limited.

Default:3600

Bodyapplication/json

statusstringrequired

Value:"password_reset_email_sent"

Response

{
  "status": "password_reset_email_sent"
}