requestEmailOtp

Public: no authentication required.

Send a 6-digit OTP to the given email.

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 RequestEmailOtp($input: RequestEmailOtpInput!) {
  requestEmailOtp(input: $input)
}

cURL

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

Variables:

{
  "input": {
    "email": "string"
  }
}

Response:

{
  "data": {
    "requestEmailOtp": true
  }
}

requestEmailOtp(
  input: RequestEmailOtpInput!
): Boolean!

Arguments

requestEmailOtp.input ● RequestEmailOtpInput! non-null input

The details of the request email otp request.

Type

Boolean scalar

The Boolean scalar type represents true or false.