forgotPassword

Public: no authentication required.

Emails a password reset link to a staff account. It returns true whether or not an account matches, so the response does not reveal which email addresses have accounts. 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 ForgotPassword($forgotPasswordInput: ForgotPasswordInput!) {
  forgotPassword(forgotPasswordInput: $forgotPasswordInput)
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation ForgotPassword($forgotPasswordInput: ForgotPasswordInput!) {\n  forgotPassword(forgotPasswordInput: $forgotPasswordInput)\n}",
  "variables": {
    "forgotPasswordInput": {
      "email": "string"
    }
  }
}
EOF

Variables:

{
  "forgotPasswordInput": {
    "email": "string"
  }
}

Response:

{
  "data": {
    "forgotPassword": true
  }
}

forgotPassword(
  forgotPasswordInput: ForgotPasswordInput!
): Boolean!

Arguments

forgotPassword.forgotPasswordInput ● ForgotPasswordInput! non-null input

The email address and the organization subdomain. When the subdomain is omitted, the request host decides the organization.

Type

Boolean scalar

The Boolean scalar type represents true or false.