Users .: Reset Password

API Reference / v15

Reset a User’s Password

This endpoint emails a user instructions about how to recover their account in the event they have forgotten their password.

Request Endpoint

POST /v15/passwords

No Authorization Required

Request Body

  "email": "",
  "api_key": "23eef8c2895ce66eb4500bb5e324b200f5339e6fe6d8665f6de0205f43f3b563"

Request Parameters

Param Type Required Description
email String Yes The user’s email address.
api_key String No The app’s API Key.

cURL Example

curl \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{
        "email": "",
        "api_key": "23eef8c2895ce66eb4500bb5e324b200f5339e6fe6d8665f6de0205f43f3b563"

Example Response

If the email address belongs to an existing user and they have been emailed instructions about how to reset their password; or if email is a valid email address but does not belong to an existing user.

HTTP/1.1 204 No Content

(No response body.)


If email is blank or otherwise invalid

HTTP/1.1 422 Unprocessable Entity

    "error": {
      "object": "base",
      "property": "email",
      "message": "Email is invalid"