Skip to main content
Requests a password reset for a user based on their email address.

Arguments

input
required
mutation requestPasswordReset($input: RequestPasswordResetInput!) {
  requestPasswordReset(input: $input) {
    requestPasswordReset {
      email
    }
    errors {
      ... on AuthenticationError {
        advice
        code
        message
      }
      ... on ForbiddenError {
        advice
        code
        message
      }
    }
  }
}

Response

Returns a RequestPasswordResetPayload
{
  "data": {
    "requestPasswordReset": {
      "requestPasswordReset": RequestPasswordReset,
      "errors": [
        AuthenticationError
      ]
    }
  }
}