Stytch · Schema

api_b2b_magic_v1_b2b_magic_links_email_discovery_SendRequest

Request type

AuthenticationIdentityPasswordlessSecurityB2BConnected AppsMCPAI AgentsDeveloper Tools

Properties

Name	Type	Description
email_address	string	The email address of the Member.
discovery_redirect_url	string	The URL that the end user clicks from the discovery Magic Link. This URL should be an endpoint in the backend server that verifies the request by querying Stytch's discovery authenticate endpoint and
pkce_code_challenge	string	A base64url encoded SHA256 hash of a one time secret used to validate that the request starts and ends on the same device.
login_template_id	string	Use a custom template for discovery 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 buil
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 an discovery magic link email. If not accepted within this time frame, the email will need to be resent. Defaults to 60 (1 hour) with a minimum of 5 and a maximum

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_b2b_magic_v1_b2b_magic_links_email_discovery_SendRequest",
  "title": "api_b2b_magic_v1_b2b_magic_links_email_discovery_SendRequest",
  "type": "object",
  "properties": {
    "email_address": {
      "type": "string",
      "description": "The email address of the Member."
    },
    "discovery_redirect_url": {
      "type": "string",
      "description": "The URL that the end user clicks from the discovery Magic Link. This URL should be an endpoint in the backend server that\n  verifies the request by querying Stytch's discovery authenticate endpoint and continues the flow. If this value is not passed, the default\n  discovery redirect URL that you set in your Dashboard is used. If you have not set a default discovery redirect URL, an error is returned."
    },
    "pkce_code_challenge": {
      "type": "string",
      "description": "A base64url encoded SHA256 hash of a one time secret used to validate that the request starts and ends on the same device."
    },
    "login_template_id": {
      "type": "string",
      "description": "Use a custom template for discovery 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 \u201cMagic Links - Login\u201d."
    },
    "locale": {
      "$ref": "#/components/schemas/api_b2b_magic_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 an discovery magic link email. If not accepted within this time frame, the email will need to be resent. Defaults to 60 (1 hour) with a minimum of 5 and a maximum of 10080 (1 week)."
    }
  },
  "description": "Request type",
  "required": [
    "email_address"
  ]
}