Stytch · Schema

api_b2b_otp_v1_b2b_otp_email_discovery_SendRequest

Request type

AuthenticationIdentityPasswordlessSecurityB2BConnected AppsMCPAI AgentsDeveloper Tools

Properties

Name Type Description
email_address string The email address to start the discovery flow for.
login_template_id string Use a custom template for login emails. By default, it will use your default email template. Templates can be added in the [Stytch dashboard](https://stytch.com/dashboard/templates) using our built-in
locale object Used to determine which language to use when sending the user this delivery method. Parameter is an [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`. C
discovery_expiration_minutes integer The expiration time, in minutes, for a discovery OTP email. If not accepted within this time frame, the OTP will need to be resent. Defaults to 10 with a minimum of 2 and a maximum of 15.
View JSON Schema on GitHub

JSON Schema

stytch-api-b2b-otp-v1-b2b-otp-email-discovery-sendrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_b2b_otp_v1_b2b_otp_email_discovery_SendRequest",
  "title": "api_b2b_otp_v1_b2b_otp_email_discovery_SendRequest",
  "type": "object",
  "properties": {
    "email_address": {
      "type": "string",
      "description": "The email address to start the discovery flow for."
    },
    "login_template_id": {
      "type": "string",
      "description": "Use a custom template for login emails. By default, it will use your default email template. Templates can be added in the [Stytch dashboard](https://stytch.com/dashboard/templates) using our built-in customization options or custom HTML templates with type \u201cOTP - Login\u201d."
    },
    "locale": {
      "$ref": "#/components/schemas/api_b2b_otp_v1_SendRequestLocale",
      "description": "Used to determine which language to use when sending the user this delivery method. Parameter is an [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `\"en\"`.\n\nCurrently supported languages are English (`\"en\"`), Spanish (`\"es\"`), French (`\"fr\"`) and Brazilian Portuguese (`\"pt-br\"`); if no value is provided, the copy defaults to English.\n\nRequest support for additional languages [here](https://docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link\")!\n"
    },
    "discovery_expiration_minutes": {
      "type": "integer",
      "format": "int32",
      "minimum": 0,
      "description": "The expiration time, in minutes, for a discovery OTP email. If not accepted within this time frame, the OTP will need to be resent. Defaults to 10 with a minimum of 2 and a maximum of 15."
    }
  },
  "description": "Request type",
  "required": [
    "email_address"
  ]
}