View Source Auth0.Management.EmailTemplates (Auth0Api v2.5.1)

Facade for the Auth0 Management API Email Templates endpoints.

Most applications should call Auth0.Api.Management instead of this module.

Summary

Types

config()
error()
template_name()

Functions

create(params, config)

Create an email template.

get(template_name, config)

Retrieve an email template by pre-defined name. These names are verify_email, verify_email_by_code, reset_email, 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.

patch(template_name, params, config)

Modify an email template.

update(template_name, params, config)

Update an email template.

Types

Link to this type

config()

View Source 
@type config() :: Auth0.Config.t()
Link to this type

error()

View Source 
@type error() :: {:error, integer(), term()} | {:error, term()}
Link to this type

template_name()

View Source 
@type template_name() :: String.t()

Functions

Link to this function

create(params, config)

View Source 
@spec create(map(), config()) :: {:ok, map()} | error()

Create an email template.

see

https://auth0.com/docs/api/management/v2/email-templates/post-email-templates

Link to this function

get(template_name, config)

View Source 
@spec get(template_name(), config()) :: {:ok, map()} | error()

Retrieve an email template by pre-defined name. These names are verify_email, verify_email_by_code, reset_email, 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.

see

https://auth0.com/docs/api/management/v2/email-templates/get-email-templates-by-template-name

Link to this function

patch(template_name, params, config)

View Source 
@spec patch(template_name(), map(), config()) :: {:ok, map()} | error()

Modify an email template.

see

https://auth0.com/docs/api/management/v2/email-templates/patch-email-templates-by-template-name

Link to this function

update(template_name, params, config)

View Source 
@spec update(template_name(), map(), config()) :: {:ok, map()} | error()

Update an email template.

see

https://auth0.com/docs/api/management/v2/email-templates/put-email-templates-by-template-name