Skip to main content

requestStaffSignInCode

Public: no authentication required.

Sends a one-time sign-in code to a staff account by email and, when the organization has WhatsApp sign-in on, by WhatsApp too. Same code, same limits and same refusals as requestLoginOtp, but it also answers what became of the WhatsApp half: SENT, PENDING (the provider had not answered in about 2 seconds) or NOT_SENT with a reason code. The email always goes. 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:

mutation RequestStaffSignInCode($requestOtpInput: RequestOtpInput!) {
  requestStaffSignInCode(requestOtpInput: $requestOtpInput) {
    sent
    whatsapp {
      status
      reason
    }
  }
}

Variables:

{
  "requestOtpInput": {}
}

Response:

{
  "data": {
    "requestStaffSignInCode": {
      "sent": true,
      "whatsapp": {
        "status": "NOT_SENT",
        "reason": "NOT_ON_WHATSAPP"
      }
    }
  }
}
requestStaffSignInCode(
  requestOtpInput: RequestOtpInput!
): SignInCodeResult!

Arguments​

requestStaffSignInCode.requestOtpInput ● RequestOtpInput! non-null input​

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

Type​

SignInCodeResult object​

The answer to a sign-in code request.