Reset Password via API

This method initiates a password reset for a user on the account. A password reset email will be sent to the specified email address if an account exists.

Tip: You can explore and test this endpoint interactively using our OpenAPI documentation.

URL

/reset

HTTP Method

POST

Authentication

This endpoint does not require authentication. It is intended for users who have forgotten their password.

Supported Parameters

• email_address - The email address of the user to reset the password for (required)

Example cURL Request

curl -H "Content-type: application/json" \
-H "Accept: application/json" \
-X POST \
-d '{ \
  "email_address": "adam@atechmedia.com" \
}' \
https://test.deployhq.com/reset

Example Response

{
  "status": "ok",
  "message": "If an account exists with that email, a password reset has been sent."
}

Notes

• For security, the response is always the same regardless of whether the email address exists in the system
• If the account has SSO enforced, password reset is disabled and the endpoint will return a 422 error
• Users who haven't yet activated their account will receive their original invitation email instead