api_otp_v1_otp_email_SendRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_otp_v1_otp_email_SendRequest",
  "title": "api_otp_v1_otp_email_SendRequest",
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "The email address of the user to send the one-time passcode to. You may use sandbox@stytch.com to test this endpoint, see [Testing](https://stytch.com/docs/home#resources_testing) for more detail."
    },
    "expiration_minutes": {
      "type": "integer",
      "format": "int32",
      "description": "Set the expiration for the one-time passcode, in minutes. The minimum expiration is 1 minute and the maximum is 10 minutes. The default expiration is 2 minutes."
    },
    "attributes": {
      "$ref": "#/components/schemas/api_attribute_v1_Attributes",
      "description": "Provided attributes to help with fraud detection. These values are pulled and passed into Stytch endpoints by your application."
    },
    "locale": {
      "$ref": "#/components/schemas/api_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"
    },
    "user_id": {
      "type": "string",
      "description": "The unique ID of a specific User. You may use an `external_id` here if one is set for the user."
    },
    "session_token": {
      "type": "string",
      "description": "The `session_token` associated with a User's existing Session."
    },
    "session_jwt": {
      "type": "string",
      "description": "The `session_jwt` associated with a User's existing Session."
    },
    "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."
    },
    "signup_template_id": {
      "type": "string",
      "description": "Use a custom template for sign-up 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 - Sign-up\u201d."
    }
  },
  "description": "Request type",
  "required": [
    "email"
  ]
}