Auth0 API | Email Templates › Create An Email Template

Email Templates

email_templates

Methods

Create An Email Template -> { body, enabled, from, 6 more... }

post/email-templates

Create an email template.

Security

Example: Authorization: Bearer My Bearer Token

Response fields

body: string

Body of the email template.

enabled: boolean

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

from: string

Senders from email address.

subject: string

Subject line of the email.

syntax: string

Syntax of the template body.

template: "verify_email" | "verify_email_by_code" | "reset_email" | 9 more...

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, change_password (legacy), or password_reset (legacy).

includeEmailInRedirect: boolean

Optional

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.

resultUrl: string

Optional

URL to redirect the user to after a successful action.

urlLifetimeInSeconds: number

Optional

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

Request example

curl https://login0.local.dev.auth0.com/api/v2/email-templates \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $BEARER_TOKEN" \
    -d '{
      "body": "body",
      "enabled": true,
      "from": "from",
      "subject": "subject",
      "syntax": "syntax",
      "template": "verify_email"
    }'

200Example

{
  "body": "body",
  "enabled": true,
  "from": "from",
  "subject": "subject",
  "syntax": "syntax",
  "template": "verify_email",
  "includeEmailInRedirect": true,
  "resultUrl": "resultUrl",
  "urlLifetimeInSeconds": 0
}

Get An Email Template ->

EmailTemplate

get/email-templates/{templateName}

Retrieve an email template by pre-defined name. These names are verify_email, verify_email_by_code, reset_email, reset_email_by_code, welcome_email, blocked_account, stolen_credentials, enrollment_email, mfa_oob_code, and user_invitation. The names change_password, and password_reset are also supported for legacy scenarios.

Update An Email Template -> { body, enabled, from, 6 more... }

put/email-templates/{templateName}

Update an email template.

Domain types

EmailTemplate = { body, enabled, from, 6 more... }