Update an email template

Update an email template.

PUT https://{tenantDomain}/api/v2/email-templates/{templateName}

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &management.SetEmailTemplateRequestContent{
        Template: management.EmailTemplateNameEnumVerifyEmail,
    }
    client.EmailTemplates.Set(
        context.TODO(),
        management.EmailTemplateNameEnumVerifyEmail.Ptr(),
        request,
    )
}

200

{
  "template": "verify_email",
  "body": "<string>",
  "from": "[e-mail]",
  "subject": "<string>",
  "syntax": "liquid",
  "enabled": true,
  "resultUrl": "<string>",
  "urlLifetimeInSeconds": 1,
  "includeEmailInRedirect": true
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Path Parameters

templateName · 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

application/jsonapplication/x-www-form-urlencoded

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: [e-mail] · 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

200

application/json

Template successfully updated.

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: [e-mail] · 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.