resetPassword

Public: no authentication required.

Sets a new password using the token from the emailed reset link. The token works once, and the request fails if it is invalid or expired. All of the user's sessions end. Rate-limited per IP address. No sign-in needed.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation ResetPassword($resetPasswordInput: ResetPasswordInput!) {
  resetPassword(resetPasswordInput: $resetPasswordInput)
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation ResetPassword($resetPasswordInput: ResetPasswordInput!) {\n  resetPassword(resetPasswordInput: $resetPasswordInput)\n}",
  "variables": {
    "resetPasswordInput": {
      "password": "string",
      "token": "string"
    }
  }
}
EOF

Variables:

{
  "resetPasswordInput": {
    "password": "string",
    "token": "string"
  }
}

Response:

{
  "data": {
    "resetPassword": true
  }
}

resetPassword(
  resetPasswordInput: ResetPasswordInput!
): Boolean!

Arguments

resetPassword.resetPasswordInput ● ResetPasswordInput! non-null input

The token from the reset link and the new password.

Type

Boolean scalar

The Boolean scalar type represents true or false.