Skip to main content
POST
/
email-templates
TypeScript
import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.emailTemplates.create({
        template: "verify_email",
    });
}
main();
{
  "template": "verify_email",
  "body": "<string>",
  "from": "sender@auth0.com",
  "subject": "<string>",
  "syntax": "liquid",
  "enabled": true,
  "resultUrl": "<string>",
  "urlLifetimeInSeconds": 1,
  "includeEmailInRedirect": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

​
template
enum<string>
default:verify_email
required

Template name. Can be verify_email, verify_email_by_code, reset_email, reset_email_by_code, welcome_email, blocked_account, stolen_credentials, enrollment_email, mfa_oob_code, user_invitation, async_approval, change_password (legacy), or password_reset (legacy).

Available options:
verify_email,
verify_email_by_code,
reset_email,
reset_email_by_code,
welcome_email,
blocked_account,
stolen_credentials,
enrollment_email,
mfa_oob_code,
user_invitation,
change_password,
password_reset,
async_approval
​
body
string | null
required

Body of the email template.

​
from
string | null
default:sender@auth0.com
required

Senders from email address.

​
subject
string | null
required

Subject line of the email.

​
syntax
string | null
default:liquid
required

Syntax of the template body.

​
enabled
boolean | null
required

Whether the template is enabled (true) or disabled (false).

​
resultUrl
string | null

URL to redirect the user to after a successful action.

​
urlLifetimeInSeconds
number | null

Lifetime in seconds that the link within the email will be valid for.

Required range: x >= 0
​
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 redirect (false). Defaults to true.

Response

Template successfully created.

​
template
enum<string>
default:verify_email
required

Template name. Can be verify_email, verify_email_by_code, reset_email, reset_email_by_code, welcome_email, blocked_account, stolen_credentials, enrollment_email, mfa_oob_code, user_invitation, async_approval, change_password (legacy), or password_reset (legacy).

Available options:
verify_email,
verify_email_by_code,
reset_email,
reset_email_by_code,
welcome_email,
blocked_account,
stolen_credentials,
enrollment_email,
mfa_oob_code,
user_invitation,
change_password,
password_reset,
async_approval
​
body
string | null
required

Body of the email template.

​
from
string | null
default:sender@auth0.com
required

Senders from email address.

​
subject
string | null
required

Subject line of the email.

​
syntax
string | null
default:liquid
required

Syntax of the template body.

​
enabled
boolean | null
required

Whether the template is enabled (true) or disabled (false).

​
resultUrl
string | null

URL to redirect the user to after a successful action.

​
urlLifetimeInSeconds
number | null

Lifetime in seconds that the link within the email will be valid for.

Required range: x >= 0
​
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 redirect (false). Defaults to true.