Auth0 · Schema

CreateEmailTemplateRequestContent

AI AgentsAuthenticationAuthorizationFGAIdentity ManagementMCPOAuthOktaOpenID ConnectSAMLSecuritySCIM

Properties

Name	Type	Description
template	object
body	stringnull	Body of the email template.
from	stringnull	Senders `from` email address.
resultUrl	stringnull	URL to redirect the user to after a successful action.
subject	stringnull	Subject line of the email.
syntax	stringnull	Syntax of the template body.
urlLifetimeInSeconds	numbernull	Lifetime in seconds that the link within the email will be valid for.
includeEmailInRedirect	boolean	Whether the `reset_email` and `verify_email` templates should include the user's email address as the `email` parameter in the returnUrl (true) or whether no email address should be included in the re
enabled	booleannull	Whether the template is enabled (true) or disabled (false).

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateEmailTemplateRequestContent",
  "title": "CreateEmailTemplateRequestContent",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "template",
    "body",
    "from",
    "subject",
    "syntax",
    "enabled"
  ],
  "properties": {
    "template": {
      "$ref": "#/components/schemas/EmailTemplateNameEnum"
    },
    "body": {
      "type": [
        "string",
        "null"
      ],
      "description": "Body of the email template."
    },
    "from": {
      "type": [
        "string",
        "null"
      ],
      "description": "Senders `from` email address.",
      "default": "[email protected]"
    },
    "resultUrl": {
      "type": [
        "string",
        "null"
      ],
      "description": "URL to redirect the user to after a successful action."
    },
    "subject": {
      "type": [
        "string",
        "null"
      ],
      "description": "Subject line of the email."
    },
    "syntax": {
      "type": [
        "string",
        "null"
      ],
      "description": "Syntax of the template body.",
      "default": "liquid"
    },
    "urlLifetimeInSeconds": {
      "type": [
        "number",
        "null"
      ],
      "description": "Lifetime in seconds that the link within the email will be valid for.",
      "minimum": 0
    },
    "includeEmailInRedirect": {
      "type": "boolean",
      "description": "Whether the `reset_email` and `verify_email` templates should include the user's email address as the `email` parameter in the returnUrl (true) or whether no email address should be included in the redirect (false). Defaults to true."
    },
    "enabled": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether the template is enabled (true) or disabled (false)."
    }
  }
}