verifyEmailChangeOtp

Requires a customer (portal or buyer app) session.

Step 2: verify the code sent to the new address and record proof of ownership server-side. Returns true/false only — no token is handed to the client. updateMyProfile consumes that proof when it writes the new email, so the address is not changed until the buyer saves.

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 VerifyEmailChangeOtp($input: VerifyEmailChangeOtpInput!) {
  verifyEmailChangeOtp(input: $input)
}

cURL

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

Variables:

{
  "input": {
    "code": "string",
    "email": "string"
  }
}

Response:

{
  "data": {
    "verifyEmailChangeOtp": true
  }
}

verifyEmailChangeOtp(
  input: VerifyEmailChangeOtpInput!
): Boolean!

Arguments

verifyEmailChangeOtp.input ● VerifyEmailChangeOtpInput! non-null input

The details of the verify email change otp request.

Type

Boolean scalar

The Boolean scalar type represents true or false.