Auth0Api v1.4.0

Auth0.Management.EmailTemplates (Auth0Api v1.4.0) View Source

Documentation for Auth0 Management API of EmailTemplates.

endpoint

  • /api/v2/email-templates
  • /api/v2/email-templates/{templateName}

Link to this section Summary

Types

config()
error()
response_body()
template_name()

Functions

create(params, config)

Create an email template.

get(template_name, config)

Get an email template.

patch(template_name, params, config)

Patch an email template.

update(template_name, params, config)

Update an email template.

Link to this section Types

Link to this type

config()

View Source

Specs

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

error()

View Source

Specs

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

response_body()

View Source

Specs

response_body() :: String.t()
Link to this type

template_name()

View Source

Specs

template_name() :: String.t()

Link to this section Functions

Link to this function

create(params, config)

View Source

Specs

create(Auth0.Management.EmailTemplates.Create.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.EmailTemplate.t(), response_body()} | 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

Specs

get(template_name(), config()) ::
  {:ok, Auth0.Entity.EmailTemplate.t(), response_body()} | error()

Get an email template.

see

https://auth0.com/docs/api/management/v2/#!/Email_Templates/get_email_templates_by_templateName

Link to this function

patch(template_name, params, config)

View Source

Specs

patch(
  template_name(),
  Auth0.Management.EmailTemplates.Patch.Params.t() | map(),
  config()
) ::
  {:ok, Auth0.Entity.EmailTemplate.t(), response_body()} | error()

Patch an email template.

see

https://auth0.com/docs/api/management/v2/#!/Email_Templates/patch_email_templates_by_templateName

Link to this function

update(template_name, params, config)

View Source

Specs

update(
  template_name(),
  Auth0.Management.EmailTemplates.Update.Params.t() | map(),
  config()
) ::
  {:ok, Auth0.Entity.EmailTemplate.t(), response_body()} | error()

Update an email template.

see

https://auth0.com/docs/api/management/v2/#!/Email_Templates/put_email_templates_by_templateName