api_magic_v1_magic_links_email_SendRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_magic_v1_magic_links_email_SendRequest",
  "title": "api_magic_v1_magic_links_email_SendRequest",
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "The email address of the User to send the Magic Link to."
    },
    "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 \u201cMagic links - Login\u201d."
    },
    "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."
    },
    "login_magic_link_url": {
      "type": "string",
      "description": "The URL the end user clicks from the login Email Magic Link. This should be a URL that your app receives and parses and subsequently send an API request to authenticate the Magic Link and log in the User. If this value is not passed, the default login redirect URL that you set in your Dashboard is used. If you have not set a default login redirect URL, an error is returned."
    },
    "signup_magic_link_url": {
      "type": "string",
      "description": "The URL the end user clicks from the sign-up Email Magic Link. This should be a URL that your app receives and parses and subsequently send an API request to authenticate the Magic Link and sign-up the User. If this value is not passed, the default sign-up redirect URL that you set in your Dashboard is used. If you have not set a default sign-up redirect URL, an error is returned."
    },
    "login_expiration_minutes": {
      "type": "integer",
      "format": "int32",
      "description": "Set the expiration for the login email magic link, in minutes. By default, it expires in 1 hour. The minimum expiration is 5 minutes and the maximum is 7 days (10080 mins)."
    },
    "signup_expiration_minutes": {
      "type": "integer",
      "format": "int32",
      "description": "Set the expiration for the sign-up email magic link, in minutes. By default, it expires in 1 week. The minimum expiration is 5 minutes and the maximum is 7 days (10080 mins)."
    },
    "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."
    },
    "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` of the user to associate the email with."
    },
    "session_jwt": {
      "type": "string",
      "description": "The `session_jwt` of the user to associate the email with."
    },
    "locale": {
      "$ref": "#/components/schemas/api_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"
    },
    "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 \u201cMagic links - Sign-up\u201d."
    }
  },
  "description": "Request type",
  "required": [
    "email"
  ]
}