api_magic_v1_magic_links_email_InviteRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_magic_v1_magic_links_email_InviteRequest",
  "title": "api_magic_v1_magic_links_email_InviteRequest",
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "The email address of the User to send the invite Magic Link to."
    },
    "invite_template_id": {
      "type": "string",
      "description": "Use a custom template for invite 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 - Invite\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."
    },
    "name": {
      "$ref": "#/components/schemas/api_user_v1_Name",
      "description": "The name of the user. Each field in the name object is optional."
    },
    "invite_magic_link_url": {
      "type": "string",
      "description": "The URL the end user clicks from the Email Magic Link. This should be a URL that your app receives and parses and subsequently sends an API request to authenticate the Magic Link and log in the User. If this value is not passed, the default invite 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."
    },
    "invite_expiration_minutes": {
      "type": "integer",
      "format": "int32",
      "description": "Set the expiration for the 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)."
    },
    "locale": {
      "$ref": "#/components/schemas/api_magic_v1_InviteRequestLocale",
      "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"
    },
    "trusted_metadata": {
      "type": "object",
      "additionalProperties": true,
      "description": "The `trusted_metadata` field contains an arbitrary JSON object of application-specific data. See the [Metadata](https://stytch.com/docs/api/metadata) reference for complete field behavior details."
    },
    "untrusted_metadata": {
      "type": "object",
      "additionalProperties": true,
      "description": "The `untrusted_metadata` field contains an arbitrary JSON object of application-specific data. Untrusted metadata can be edited by end users directly via the SDK, and **cannot be used to store critical information.** See the [Metadata](https://stytch.com/docs/api/metadata) reference for complete field behavior details."
    }
  },
  "description": "Request type",
  "required": [
    "email"
  ]
}