Logo / Docs

Email APIs

Overview

This page contains the APIs for managing Email Templates as well as emailing users using those templates. Here are the APIs:

Create an Email Template

This API is used to create an Email Template. Specifying an Id on the URI will instruct FusionAuth to use that Id when creating the Email Template. Otherwise, FusionAuth will generate an Id for the Email Template.

Request

Create an Email Template without providing an Id. An Id will be automatically generated.
POST/api/email/template
Create an Email Template with the provided Id
POST/api/email/template/{emailTemplateId}

Request Parameters

emailTemplateId[UUID]optionalDefaults to secure random UUID

The Id to use for the new Email Template. If not specified a secure random UUID will be generated.

Request Body

emailTemplate.defaultFromNameoptional

The default From Name used when sending emails. If not provided, and a localized value cannot be determined, the default value for the tenant will be used. This is the display name part of the email address ( i.e. Jared Dunn jared@piedpiper.com).

emailTemplate.defaultHtmlTemplaterequired

The default HTML Email Template.

emailTemplate.defaultSubjectrequired

The default Subject used when sending emails.

emailTemplate.defaultTextTemplaterequired

The default Text Email Template.

emailTemplate.fromEmail[String]optional

The email address that this email will be sent from. If not provided, the default value for the tenant will be used. This is the address part email address (i.e. Jared Dunn jared@piedpiper.com).

emailTemplate.localizedFromNamesoptional

The From Name used when sending emails to users who speak other languages. This overrides the default From Name based on the user’s list of preferred languages.

emailTemplate.localizedHtmlTemplatesoptional

The HTML Email Template used when sending emails to users who speak other languages. This overrides the default HTML Email Template based on the user’s list of preferred languages.

emailTemplate.localizedSubjectsoptional

The Subject used when sending emails to users who speak other languages. This overrides the default Subject based on the user’s list of preferred languages.

emailTemplate.localizedTextTemplatesoptional

The Text Email Template used when sending emails to users who speak other languages. This overrides the default Text Email Template based on the user’s list of preferred languages.

emailTemplate.name[String]required

A descriptive name for the email template (i.e. “April 2016 Coupon Email”)

Example Request JSON
{
  "emailTemplate": {
    "defaultFromName": "Administrator",
    "defaultHtmlTemplate": "<p>Hello ${user.username}</p><p>Welcome To FusionAuth!</p>",
    "defaultSubject": "Hello World",
    "defaultTextTemplate": "Hello ${user.username},\nWelcome To FusionAuth!",
    "fromEmail": "email@example.com",
    "localizedFromNames": {
      "de": "Verwalter",
      "fr": "Administrateur"
    },
    "localizedHtmlTemplates": {
      "de": "<p>Hallo ${user.username}</p><p>Willkommen auf der FusionAuth!<p>",
      "fr": "<p>Bonjour ${user.username}</p><p>Bienvenue à FusionAuth!<p>"
    },
    "localizedSubjects": {
      "de": "Hallo Welt",
      "fr": "Bonjour le monde"
    },
    "localizedTextTemplates": {
      "de": "Hallo ${user.username},\nWillkommen auf der FusionAuth!",
      "fr": "Bonjour ${user.username},\nBienvenue à FusionAuth!"
    },
    "name": "Hello World"
  }
}

Response

The response for this API contains the information for the Email Template that was created.

Response Codes
Code Description
200 The request was successful. The response will contain a JSON body.
400 The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401 You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
500 There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

Response Body

emailTemplate.defaultFromName[String]

The default From Name used when sending emails. If not provided, and a localized value cannot be determined, the default value for the tenant will be used. This is the display name part of the email address ( i.e. Jared Dunn jared@piedpiper.com).

emailTemplate.defaultHtmlTemplate[String]

The default HTML Email Template.

emailTemplate.defaultSubject[String]

The default Subject used when sending emails.

emailTemplate.defaultTextTemplate[String]

The default Text Email Template.

emailTemplate.fromEmail[String]

The email address that this email will be sent from. If not provided, the default value for the tenant will be used. This is the address part email address (i.e. Jared Dunn jared@piedpiper.com).

emailTemplate.id[UUID]

The Id of Email Template.

emailTemplate.insertInstant[Long]

The instant when the Email Template was created.

emailTemplate.lastUpdateInstant[Long]

The instant when the Email Template was last updated.

emailTemplate.localizedFromNames[Map<Locale,String>]

The From Name used when sending emails to users who speak other languages. This overrides the default From Name based on the user’s list of preferred languages.

emailTemplate.localizedHtmlTemplates[Map<Locale,String>]

The HTML Email Template used when sending emails to users who speak other languages. This overrides the default HTML Email Template based on the user’s list of preferred languages.

emailTemplate.localizedSubjects[Map<Locale,String>]

The Subject used when sending emails to users who speak other languages. This overrides the default Subject based on the user’s list of preferred languages.

emailTemplate.localizedTextTemplates[Map<Locale,String>]

The Text Email Template used when sending emails to users who speak other languages. This overrides the default Text Email Template based on the user’s list of preferred languages.

emailTemplate.name[String]

A descriptive name for the email template (i.e. “April 2016 Coupon Email”).

Example Response JSON for a Single Email Template
{
  "emailTemplate": {
    "defaultFromName": "Administrator",
    "defaultHtmlTemplate": "<p>Hello ${user.username}</p><p>Welcome To FusionAuth!</p>",
    "defaultSubject": "Hello World",
    "defaultTextTemplate": "Hello ${user.username},\nWelcome To FusionAuth!",
    "fromEmail": "email@example.com",
    "id": "00000000-0000-0000-0000-0000000000ab",
    "insertInstant": 1572469040579,
    "lastUpdateInstant": 1572477740579,
    "localizedFromNames": {
      "de": "Verwalter",
      "fr": "Administrateur"
    },
    "localizedHtmlTemplates": {
      "de": "<p>Hallo ${user.username}</p><p>Willkommen auf der FusionAuth!<p>",
      "fr": "<p>Bonjour ${user.username}</p><p>Bienvenue à FusionAuth!<p>"
    },
    "localizedSubjects": {
      "de": "Hallo Welt",
      "fr": "Bonjour le monde"
    },
    "localizedTextTemplates": {
      "de": "Hallo ${user.username},\nWillkommen auf der FusionAuth!",
      "fr": "Bonjour ${user.username},\nBienvenue à FusionAuth!"
    },
    "name": "Hello World"
  }
}

Retrieve an Email Template

This API is used to retrieve one or all of the configured Email Templates. Specifying an Id on the URI will retrieve a single Email Template. Leaving off the Id will retrieve all of the Email Templates.

Request

Retrieve all of the Email Templates
GET/api/email/template
Retrieve a single Email Template by Id
GET/api/email/template/{emailTemplateId}

Request Parameters

emailTemplateId[UUID]optional

The Id of the Email Template to retrieve.

Response

The response for this API contains either a single Email Template or all of the Email Templates. When you call this API with an Id the response will contain just that Email Template. When you call this API without an Id the response will contain all of the Email Templates. Both response types are defined below along with an example JSON response.

Code Description
200 The request was successful. The response will contain a JSON body.
401 You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
404 The object you requested doesn't exist. The response will be empty.
500 There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

Response Body

emailTemplate.defaultFromName[String]

The default From Name used when sending emails. If not provided, and a localized value cannot be determined, the default value for the tenant will be used. This is the display name part of the email address ( i.e. Jared Dunn jared@piedpiper.com).

emailTemplate.defaultHtmlTemplate[String]

The default HTML Email Template.

emailTemplate.defaultSubject[String]

The default Subject used when sending emails.

emailTemplate.defaultTextTemplate[String]

The default Text Email Template.

emailTemplate.fromEmail[String]

The email address that this email will be sent from. If not provided, the default value for the tenant will be used. This is the address part email address (i.e. Jared Dunn jared@piedpiper.com).

emailTemplate.id[UUID]

The Id of Email Template.

emailTemplate.insertInstant[Long]

The instant when the Email Template was created.

emailTemplate.lastUpdateInstant[Long]

The instant when the Email Template was last updated.

emailTemplate.localizedFromNames[Map<Locale,String>]

The From Name used when sending emails to users who speak other languages. This overrides the default From Name based on the user’s list of preferred languages.

emailTemplate.localizedHtmlTemplates[Map<Locale,String>]

The HTML Email Template used when sending emails to users who speak other languages. This overrides the default HTML Email Template based on the user’s list of preferred languages.

emailTemplate.localizedSubjects[Map<Locale,String>]

The Subject used when sending emails to users who speak other languages. This overrides the default Subject based on the user’s list of preferred languages.

emailTemplate.localizedTextTemplates[Map<Locale,String>]

The Text Email Template used when sending emails to users who speak other languages. This overrides the default Text Email Template based on the user’s list of preferred languages.

emailTemplate.name[String]

A descriptive name for the email template (i.e. “April 2016 Coupon Email”).

Example Response JSON for a Single Email Template
{
  "emailTemplate": {
    "defaultFromName": "Administrator",
    "defaultHtmlTemplate": "<p>Hello ${user.username}</p><p>Welcome To FusionAuth!</p>",
    "defaultSubject": "Hello World",
    "defaultTextTemplate": "Hello ${user.username},\nWelcome To FusionAuth!",
    "fromEmail": "email@example.com",
    "id": "00000000-0000-0000-0000-0000000000ab",
    "insertInstant": 1572469040579,
    "lastUpdateInstant": 1572477740579,
    "localizedFromNames": {
      "de": "Verwalter",
      "fr": "Administrateur"
    },
    "localizedHtmlTemplates": {
      "de": "<p>Hallo ${user.username}</p><p>Willkommen auf der FusionAuth!<p>",
      "fr": "<p>Bonjour ${user.username}</p><p>Bienvenue à FusionAuth!<p>"
    },
    "localizedSubjects": {
      "de": "Hallo Welt",
      "fr": "Bonjour le monde"
    },
    "localizedTextTemplates": {
      "de": "Hallo ${user.username},\nWillkommen auf der FusionAuth!",
      "fr": "Bonjour ${user.username},\nBienvenue à FusionAuth!"
    },
    "name": "Hello World"
  }
}

Response Body

emailTemplates[Array]

The list of all the Email Templates.

emailTemplates[x].defaultFromName[String]

The default From Name used when sending emails. If not provided, and a localized value cannot be determined, the default value for the tenant will be used. This is the display name part of the email address ( i.e. Jared Dunn jared@piedpiper.com).

emailTemplates[x].defaultHtmlTemplate[String]

The default HTML Email Template.

emailTemplates[x].defaultSubject[String]

The default Subject used when sending emails.

emailTemplates[x].defaultTextTemplate[String]

The default Text Email Template.

emailTemplates[x].fromEmail[String]

The email address that this email will be sent from. If not provided, the default value for the tenant will be used. This is the address part email address (i.e. Jared Dunn jared@piedpiper.com).

emailTemplates[x].id[UUID]

The Id of Email Template.

emailTemplates[x].insertInstant[Long]

The instant when the Email Template was created.

emailTemplates[x].lastUpdateInstant[Long]

The instant when the Email Template was last updated.

emailTemplates[x].localizedFromNames[Map<Locale,String>]

The From Name used when sending emails to users who speak other languages. This overrides the default From Name based on the user’s list of preferred languages.

emailTemplates[x].localizedHtmlTemplates[Map<Locale,String>]

The HTML Email Template used when sending emails to users who speak other languages. This overrides the default HTML Email Template based on the user’s list of preferred languages.

emailTemplates[x].localizedSubjects[Map<Locale,String>]

The Subject used when sending emails to users who speak other languages. This overrides the default Subject based on the user’s list of preferred languages.

emailTemplates[x].localizedTextTemplates[Map<Locale,String>]

The Text Email Template used when sending emails to users who speak other languages. This overrides the default Text Email Template based on the user’s list of preferred languages.

emailTemplates[x].name[String]

A descriptive name for the email template (i.e. “April 2016 Coupon Email”).

Example Response JSON for all the Email Templates
{
  "emailTemplates": [
    {
      "defaultFromName": "Administrator",
      "defaultHtmlTemplate": "<p>Hello ${user.username}</p><p>Welcome To FusionAuth!</p>",
      "defaultSubject": "Hello World",
      "defaultTextTemplate": "Hello ${user.username},\nWelcome To FusionAuth!",
      "fromEmail": "email@example.com",
      "id": "00000000-0000-0000-0000-0000000000ab",
      "insertInstant": 1572469040579,
      "lastUpdateInstant": 1572477740579,
      "localizedFromNames": {
        "de": "Verwalter",
        "fr": "Administrateur"
      },
      "localizedHtmlTemplates": {
        "de": "<p>Hallo ${user.username}</p><p>Willkommen auf der FusionAuth!<p>",
        "fr": "<p>Bonjour ${user.username}</p><p>Bienvenue à FusionAuth!<p>"
      },
      "localizedSubjects": {
        "de": "Hallo Welt",
        "fr": "Bonjour le monde"
      },
      "localizedTextTemplates": {
        "de": "Hallo ${user.username},\nWillkommen auf der FusionAuth!",
        "fr": "Bonjour ${user.username},\nBienvenue à FusionAuth!"
      },
      "name": "Hello World"
    }
  ]
}

Search for Email Templates

This API has been available since 1.45.0

This API is used to search for Email Templates and may be called using the GET or POST HTTP methods. Examples of each are provided below. The POST method is provided to allow for a richer request object without worrying about exceeding the maximum length of a URL. Calling this API with either the GET or POST HTTP method will provide the same search results given the same query parameters.

Request

Search for Email Templates
GET/api/email/template/search?name={name}

Request Parameters

name[String]optional

The case-insensitive string to search for in the Email Template name. This can contain wildcards using the asterisk character (*). If no wildcards are present, the search criteria will be interpreted as *value*.

numberOfResults[Integer]optionalDefaults to 25

The number of results to return from the search.

orderBy[String]optionalDefaults to name ASC

The database field to order the search results as well as an order direction.

The possible values are:

  • id - the unique Id of the Email Template
  • insertInstant - the instant when the Email Template was created
  • name - the Email Template name

The order direction is optional. Possible values of the order direction are ASC or DESC. If omitted, the default sort order is ASC.

For example, to order the results by the insert instant in a descending order, use insertInstant DESC.

startRow[Integer]optionalDefaults to 0

The offset into the total results. In order to paginate the results, increment this value by the numberOfResults for subsequent requests.

For example, if the total search results are greater than the page size designated by numberOfResults , set this value to 25 to retrieve results 26-50, assuming the default page size.

Search for Email Templates
POST/api/email/template/search

When calling the API using a POST request you will send the search criteria in a JSON request body.

Request Body

search.name[String]optional

The case-insensitive string to search for in the Email Template name. This can contain wildcards using the asterisk character (*). If no wildcards are present, the search criteria will be interpreted as *value*.

search.numberOfResults[Integer]optionalDefaults to 25

The number of results to return from the search.

search.orderBy[String]optionalDefaults to name ASC

The database field to order the search results as well as an order direction.

The possible values are:

  • id - the unique Id of the Email Template
  • insertInstant - the instant when the Email Template was created
  • name - the Email Template name

The order direction is optional. Possible values of the order direction are ASC or DESC. If omitted, the default sort order is ASC.

For example, to order the results by the insert instant in a descending order, use insertInstant DESC.

search.startRow[Integer]optionalDefaults to 0

The offset into the total results. In order to paginate the results, increment this value by the numberOfResults for subsequent requests.

For example, if the total search results are greater than the page size designated by numberOfResults , set this value to 25 to retrieve results 26-50, assuming the default page size.

Example JSON Request
{
  "search": {
    "name": "Hello",
    "numberOfResults": 25,
    "orderBy": "insertInstant",
    "startRow": 0
  }
}

Response

The response for this API contains the Email Templates matching the search criteria in paginated format.

Code Description
200 The request was successful. The response will contain a JSON body.
400 The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401 You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
500 There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

Response Body

emailTemplates[Array]

The list of all the Email Templates.

emailTemplates[x].defaultFromName[String]

The default From Name used when sending emails. If not provided, and a localized value cannot be determined, the default value for the tenant will be used. This is the display name part of the email address ( i.e. Jared Dunn jared@piedpiper.com).

emailTemplates[x].defaultHtmlTemplate[String]

The default HTML Email Template.

emailTemplates[x].defaultSubject[String]

The default Subject used when sending emails.

emailTemplates[x].defaultTextTemplate[String]

The default Text Email Template.

emailTemplates[x].fromEmail[String]

The email address that this email will be sent from. If not provided, the default value for the tenant will be used. This is the address part email address (i.e. Jared Dunn jared@piedpiper.com).

emailTemplates[x].id[UUID]

The Id of Email Template.

emailTemplates[x].insertInstant[Long]

The instant when the Email Template was created.

emailTemplates[x].lastUpdateInstant[Long]

The instant when the Email Template was last updated.

emailTemplates[x].localizedFromNames[Map<Locale,String>]

The From Name used when sending emails to users who speak other languages. This overrides the default From Name based on the user’s list of preferred languages.

emailTemplates[x].localizedHtmlTemplates[Map<Locale,String>]

The HTML Email Template used when sending emails to users who speak other languages. This overrides the default HTML Email Template based on the user’s list of preferred languages.

emailTemplates[x].localizedSubjects[Map<Locale,String>]

The Subject used when sending emails to users who speak other languages. This overrides the default Subject based on the user’s list of preferred languages.

emailTemplates[x].localizedTextTemplates[Map<Locale,String>]

The Text Email Template used when sending emails to users who speak other languages. This overrides the default Text Email Template based on the user’s list of preferred languages.

emailTemplates[x].name[String]

A descriptive name for the email template (i.e. “April 2016 Coupon Email”).

total[Integer]

The total number of Email Templates matching the search criteria. Use this value along with the numberOfResults and startRow in the Search request to perform pagination.

Example Response JSON for Email Template Search
{
  "emailTemplates": [
    {
      "defaultFromName": "Administrator",
      "defaultHtmlTemplate": "<p>Hello ${user.username}</p><p>Welcome To FusionAuth!</p>",
      "defaultSubject": "Hello World",
      "defaultTextTemplate": "Hello ${user.username},\nWelcome To FusionAuth!",
      "fromEmail": "email@example.com",
      "id": "00000000-0000-0000-0000-0000000000ab",
      "insertInstant": 1572469040579,
      "lastUpdateInstant": 1572477740579,
      "localizedFromNames": {
        "de": "Verwalter",
        "fr": "Administrateur"
      },
      "localizedHtmlTemplates": {
        "de": "<p>Hallo ${user.username}</p><p>Willkommen auf der FusionAuth!<p>",
        "fr": "<p>Bonjour ${user.username}</p><p>Bienvenue à FusionAuth!<p>"
      },
      "localizedSubjects": {
        "de": "Hallo Welt",
        "fr": "Bonjour le monde"
      },
      "localizedTextTemplates": {
        "de": "Hallo ${user.username},\nWillkommen auf der FusionAuth!",
        "fr": "Bonjour ${user.username},\nBienvenue à FusionAuth!"
      },
      "name": "Hello World"
    }
  ],
  "total": 1
}

Update an Email Template

This API is used to update an existing Email Template.

You must specify all of the properties of the Email Template when calling this API with the PUT HTTP method. When used with PUT, this API doesn’t merge the existing Email Template and your new data. It replaces the existing Email Template with your new data.

Utilize the PATCH HTTP method to send specific changes to merge into an existing Email Template.

Request

Update an Email Template by Id
PUT/api/email/template/{emailTemplateId}
PATCH/api/email/template/{emailTemplateId}

When using the PATCH method, you can either use the same request body documentation that is provided for the PUT request for backward compatibility. Or you may use either JSON Patch/RFC 6902] or JSON Merge Patch/RFC 7396. See the PATCH documentation for more information.

When using the PATCH method with a Content-Type of application/json the provided request parameters will be merged into the existing object, this means all parameters are optional when using the PATCH method and you only provide the values you want changed. A null value can be used to remove a value. Patching an Array will result in all values from the new list being appended to the existing list, this is a known limitation to the current implementation of PATCH.

Request Parameters

emailTemplateId[UUID]required

The Id of the Email Template to update.

Request Body

emailTemplate.defaultFromNameoptional

The default From Name used when sending emails. If not provided, and a localized value cannot be determined, the default value for the tenant will be used. This is the display name part of the email address ( i.e. Jared Dunn jared@piedpiper.com).

emailTemplate.defaultHtmlTemplaterequired

The default HTML Email Template.

emailTemplate.defaultSubjectrequired

The default Subject used when sending emails.

emailTemplate.defaultTextTemplaterequired

The default Text Email Template.

emailTemplate.fromEmail[String]optional

The email address that this email will be sent from. If not provided, the default value for the tenant will be used. This is the address part email address (i.e. Jared Dunn jared@piedpiper.com).

emailTemplate.localizedFromNamesoptional

The From Name used when sending emails to users who speak other languages. This overrides the default From Name based on the user’s list of preferred languages.

emailTemplate.localizedHtmlTemplatesoptional

The HTML Email Template used when sending emails to users who speak other languages. This overrides the default HTML Email Template based on the user’s list of preferred languages.

emailTemplate.localizedSubjectsoptional

The Subject used when sending emails to users who speak other languages. This overrides the default Subject based on the user’s list of preferred languages.

emailTemplate.localizedTextTemplatesoptional

The Text Email Template used when sending emails to users who speak other languages. This overrides the default Text Email Template based on the user’s list of preferred languages.

emailTemplate.name[String]required

A descriptive name for the email template (i.e. “April 2016 Coupon Email”)

Example Request JSON
{
  "emailTemplate": {
    "defaultFromName": "Administrator",
    "defaultHtmlTemplate": "<p>Hello ${user.username}</p><p>Welcome To FusionAuth!</p>",
    "defaultSubject": "Hello World",
    "defaultTextTemplate": "Hello ${user.username},\nWelcome To FusionAuth!",
    "fromEmail": "email@example.com",
    "localizedFromNames": {
      "de": "Verwalter",
      "fr": "Administrateur"
    },
    "localizedHtmlTemplates": {
      "de": "<p>Hallo ${user.username}</p><p>Willkommen auf der FusionAuth!<p>",
      "fr": "<p>Bonjour ${user.username}</p><p>Bienvenue à FusionAuth!<p>"
    },
    "localizedSubjects": {
      "de": "Hallo Welt",
      "fr": "Bonjour le monde"
    },
    "localizedTextTemplates": {
      "de": "Hallo ${user.username},\nWillkommen auf der FusionAuth!",
      "fr": "Bonjour ${user.username},\nBienvenue à FusionAuth!"
    },
    "name": "Hello World"
  }
}

Response

The response for this API contains the new information for the Email Template that was updated.

Code Description
200 The request was successful. The response will contain a JSON body.
400 The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401 You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
404 The object you are trying to update doesn't exist. The response will be empty.
500 There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

Response Body

emailTemplate.defaultFromName[String]

The default From Name used when sending emails. If not provided, and a localized value cannot be determined, the default value for the tenant will be used. This is the display name part of the email address ( i.e. Jared Dunn jared@piedpiper.com).

emailTemplate.defaultHtmlTemplate[String]

The default HTML Email Template.

emailTemplate.defaultSubject[String]

The default Subject used when sending emails.

emailTemplate.defaultTextTemplate[String]

The default Text Email Template.

emailTemplate.fromEmail[String]

The email address that this email will be sent from. If not provided, the default value for the tenant will be used. This is the address part email address (i.e. Jared Dunn jared@piedpiper.com).

emailTemplate.id[UUID]

The Id of Email Template.

emailTemplate.insertInstant[Long]

The instant when the Email Template was created.

emailTemplate.lastUpdateInstant[Long]

The instant when the Email Template was last updated.

emailTemplate.localizedFromNames[Map<Locale,String>]

The From Name used when sending emails to users who speak other languages. This overrides the default From Name based on the user’s list of preferred languages.

emailTemplate.localizedHtmlTemplates[Map<Locale,String>]

The HTML Email Template used when sending emails to users who speak other languages. This overrides the default HTML Email Template based on the user’s list of preferred languages.

emailTemplate.localizedSubjects[Map<Locale,String>]

The Subject used when sending emails to users who speak other languages. This overrides the default Subject based on the user’s list of preferred languages.

emailTemplate.localizedTextTemplates[Map<Locale,String>]

The Text Email Template used when sending emails to users who speak other languages. This overrides the default Text Email Template based on the user’s list of preferred languages.

emailTemplate.name[String]

A descriptive name for the email template (i.e. “April 2016 Coupon Email”).

Example Response JSON for a Single Email Template
{
  "emailTemplate": {
    "defaultFromName": "Administrator",
    "defaultHtmlTemplate": "<p>Hello ${user.username}</p><p>Welcome To FusionAuth!</p>",
    "defaultSubject": "Hello World",
    "defaultTextTemplate": "Hello ${user.username},\nWelcome To FusionAuth!",
    "fromEmail": "email@example.com",
    "id": "00000000-0000-0000-0000-0000000000ab",
    "insertInstant": 1572469040579,
    "lastUpdateInstant": 1572477740579,
    "localizedFromNames": {
      "de": "Verwalter",
      "fr": "Administrateur"
    },
    "localizedHtmlTemplates": {
      "de": "<p>Hallo ${user.username}</p><p>Willkommen auf der FusionAuth!<p>",
      "fr": "<p>Bonjour ${user.username}</p><p>Bienvenue à FusionAuth!<p>"
    },
    "localizedSubjects": {
      "de": "Hallo Welt",
      "fr": "Bonjour le monde"
    },
    "localizedTextTemplates": {
      "de": "Hallo ${user.username},\nWillkommen auf der FusionAuth!",
      "fr": "Bonjour ${user.username},\nBienvenue à FusionAuth!"
    },
    "name": "Hello World"
  }
}

Delete an Email Template

This API is used to delete an Email Template. You must specify the Id of the Email Template on the URI.

Request

Delete an Email Template By Id
DELETE/api/email/template/{emailTemplateId}

Request Parameters

emailTemplateId[UUID]required

The Id of the Email Template to delete.

Response

This API does not return a JSON response body.

Code Description
200 The request was successful. The response will contain a JSON body.
400 The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401 You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
404 The object you requested doesn't exist. The response will be empty.
500 There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

Preview an Email Template

This API is used to preview an Email Template. You simply pass all of the information for the Email Template in the request and a rendered version of the Email is sent back to you in the response. The Email Template in the request does not need to be completely filled out either. You can send in a partial Email Template and the response will contain only what you provided.

Request

Preview an Email Template
POST/api/email/template/preview

Request Body

emailTemplate.defaultFromNamerequired

The default From Name used when sending emails. This is the display name part of the email address ( i.e. Jared Dunn jared@piedpiper.com).

emailTemplate.defaultHtmlTemplaterequired

The default HTML Email Template.

emailTemplate.defaultSubjectrequired

The default Subject used when sending emails.

emailTemplate.defaultTextTemplaterequired

The default Text Email Template.

emailTemplate.fromEmail[String]required

The email address that this email will be sent from. This is the address part email address (i.e. Jared Dunn jared@piedpiper.com).

emailTemplate.localizedFromNamesoptional

The From Name used when sending emails to users who speak other languages. This overrides the default From Name based on the user’s list of preferred languages.

emailTemplate.localizedHtmlTemplatesoptional

The HTML Email Template used when sending emails to users who speak other languages. This overrides the default HTML Email Template based on the user’s list of preferred languages.

emailTemplate.localizedSubjectsoptional

The Subject used when sending emails to users who speak other languages. This overrides the default Subject based on the user’s list of preferred languages.

emailTemplate.localizedTextTemplatesoptional

The Text Email Template used when sending emails to users who speak other languages. This overrides the default Text Email Template based on the user’s list of preferred languages.

locale[Locale]optional

The locale to use when rendering the Email Template. If this is null, the defaults will be used and the localized versions will be ignored.

Example Request JSON
{
  "emailTemplate": {
    "defaultFromName": "Administrator",
    "defaultHtmlTemplate": "<p>Hello ${user.username}</p><p>Welcome To FusionAuth!</p>",
    "defaultSubject": "Hello World",
    "defaultTextTemplate": "Hello ${user.username},\nWelcome To FusionAuth!",
    "fromEmail": "email@example.com",
    "localizedFromNames": {
      "de": "Verwalter",
      "fr": "Administrateur"
    },
    "localizedHtmlTemplates": {
      "de": "<p>Hallo ${user.username}</p><p>Willkommen auf der FusionAuth!<p>",
      "fr": "<p>Bonjour ${user.username}</p><p>Bienvenue à FusionAuth!<p>"
    },
    "localizedSubjects": {
      "de": "Hallo Welt",
      "fr": "Bonjour le monde"
    },
    "localizedTextTemplates": {
      "de": "Hallo ${user.username},\nWillkommen auf der FusionAuth!",
      "fr": "Bonjour ${user.username},\nBienvenue à FusionAuth!"
    }
  },
  "locale": "de"
}

Response

The response for this API contains the rendered Email and also an Errors that contains any rendering issues FusionAuth found. The template might have syntax or logic errors and FusionAuth will put these errors into the response.

Response Codes
Code Description
200 The request was successful. The response will contain a JSON body.
400 The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401 You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
500 There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

Response Body

email.from.address[String]

The email address that this email will be sent from. This is the address part email address (i.e. Jared Dunn jared@piedpiper.com).

email.from.display[String]

The From display name this email will be sent from. This is the name part email address ( i.e. Jared Dunn jared@piedpiper.com).

email.html[String]

The HTML Email.

email.subject[String]

The Subject used when sending the email.

email.text[String]

The Text Email.

email.errors

An Errors object that contains any errors in the Email Template.

Example Response JSON
{
  "email": {
    "from": {
      "address": "email@example.com",
      "display": "Verwalter"
    },
    "html": "<p>Hallo {{user.username}}</p><p>Willkommen auf der FusionAuth!<p>",
    "subject": "Hallo Welt",
    "text": "Hallo {{user.username}},\nWillkommen auf der FusionAuth!"
  },
  "errors": {}
}

Send an Email

This API is used to send an Email to one or more users using an Email Template.

Request

Send an email using a template by Id
POST/api/email/send/{emailTemplateId}

Request Parameters

emailTemplateId[UUID]required

The Id of the Email Template to use to generate the Email from.

Request Body

applicationId[UUID]optionalavailable since 1.28.0

An optional application Id, when provided the application object will be available in the email template for variable replacement.

bccAddresses[Array<String>]optional

A list of email addresses to BCC when sending the Email.

ccAddresses[Array<String>]optional

A list of email addresses to CC when sending the Email.

preferredLanguages[Array<String>]available since 1.28.0

An ordered list of locale strings to utilize when localizing the email template for address provided in the toAddresses . See Locales.

requestData[Object]optional

An optional JSON object that is passed to the Email Template during rendering. The variables in the JSON object will be accessible to the FreeMarker templates of the Email Template.

toAddresses[Array]optionalavailable since 1.28.0

A list of email addresses to send the Email to. It is not required that a user exist in FusionAuth with this email address, this may be useful when sending invitations to users that do not yet exist in FusionAuth.

This field may be used in addition to, or as an alternative to the userIds field.

toAddresses.address[String]required

The email address for the user. Using the toAddresses is optional, but when providing one or more entries, this field is required.

toAddresses.display[String]optional

An optional display name that can be used to construct the to address.

For example, in this example string Erlich Bachman<bachman@piedpiper.com>, Erlich Bachman is the display name and bachman@piedpiper.com is the address.

userIds[Array<UUID>]optional

The list of User Ids to send the Email to.

This field may be used in addition to, or as an alternative to the toAddresses field.

Prior to version 1.28.0, this field was required.

Example Request JSON
{
  "bccAddresses": [
    "jared@piedpiper.com"
  ],
  "ccAddresses": [
    "james@bond.com"
  ],
  "requestData": {
    "message": "Thank you for purchasing the answer to the universe. We appreciate your business",
    "paymentAmount": 42
  },
  "toAddresses": [
    {
      "address": "accounting@piedpiper.com",
      "display": "Piped Piper Accounting"
    },
    {
      "address": "sales@piedpiper.com"
    }
  ],
  "userIds": [
    "ce485a91-906f-4615-af75-81d37dc71e90"
  ]
}

Response

Response Codes
Code Description
202 The request was successful. The response will contain a JSON body. If the JSON body is empty the template was rendered correctly and queued to be sent for all user Ids provided. If one or more failed the response will contain errors in the response format documented below.
400 The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401 You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
500 There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

Response Body

anonymousResults[Map<String,Object>]available since 1.28.0

This is a Mapping between the email address that had errors and the errors that were encountered. This mapping is used for errors that occur when using the toAddresses field on the send request.

anonymousResults[email].parseErrors[Map<String,String>]available since 1.28.0

Contains any parse errors that occurred while parsing the Email Template parts. The key of the Map is the field that failed (i.e. from) and the value is the error message.

anonymousResults[email].renderErrors[Map<String,String>]available since 1.28.0

Contains any template errors that occurred while executing the Email Template parts. The key of the Map is the field that failed (i.e. from) and the value is the error message.

results[Map<UUID,Object>]

This is a Mapping between the User Ids that had errors and the errors that were encountered.

results[userId].parseErrors[Map<String,String>]

Contains any parse errors that occurred while parsing the Email Template parts. The key of the Map is the field that failed (i.e. from) and the value is the error message.

results[userId].renderErrors[Map<String,String>]

Contains any template errors that occurred while executing the Email Template parts. The key of the Map is the field that failed (i.e. from) and the value is the error message.

Example Response JSON
{
  "results": {
    "00000000-0000-0001-0000-000000000000": {
      "renderErrors": {
        "html": "freemarker.core.InvalidReferenceException: The following has evaluated to null or missing:\n==> requestData.not  [in nameless template at line 1, column 3]\n\n----\nTip: It's the step after the last dot that caused this error, not those before it.\n----\nTip: If the failing expression is known to be legally refer to something that's sometimes null or missing, either specify a default value like myOptionalVar!myDefault, or use [#if myOptionalVar??]when-present[#else]when-missing[/#if]. (These only cover the last step of the expression; to cover the whole expression, use parenthesis: (myOptionalVar.foo)!myDefault, (myOptionalVar.foo)??\n----\n\n----\nFTL stack trace (\"~\" means nesting-related):\n\t- Failed at: ${requestData.not.here}  [in nameless template at line 1, column 1]\n----"
      }
    }
  }
}