Logo / Docs

Message Template APIs

Overview

This API has been available since 1.26.0

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

Create a Message Template

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

Request

Create a Message Template without providing an Id. An Id will be automatically generated.
POST/api/message/template
Create a Message Template with the provided Id
POST/api/message/template/{messageTemplateId}

Request Parameters

messageTemplateId[UUID]optionalDefaults to secure random UUID

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

Request Body

messageTemplate.data[Object]optional

An object that can hold any information about the Message Template that should be persisted.

messageTemplate.defaultTemplate[[String (FreeMarker Enabled)]]required

The default Message Template.

messageTemplate.localizedTemplates[[Map<Locale,String (FreeMarker Enabled)>]]optional

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

messageTemplate.name[String]required

A descriptive name for the Message Template (i.e. “Two Factor Code Message”)

messageTemplate.type[String]required

The type of the template. This must have the value SMS.

Example Request JSON
{
  "messageTemplate": {
    "data": {
      "updatedBy": "richard@fusionauth.io"
    },
    "defaultTemplate": "Here's your Two Factor Code: ${code}",
    "localizedTemplates": {
      "de": "Hier ist Ihr Zwei-Faktoren-Code: ${code}",
      "es": "Este es su código de dos factores: ${code}"
    },
    "name": "Default Two Factor Request",
    "type": "SMS"
  }
}

Response

The response for this API contains the information for the Message 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

messageTemplate.data[Object]

An object that can hold any information about the Message Template that should be persisted.

messageTemplate.defaultTemplate[[String (FreeMarker Enabled)]]

The default Message Template.

messageTemplate.id[UUID]

The unique identifier for this Message Template.

messageTemplate.insertInstant[Long]

The instant that the Application was added to the FusionAuth database.

messageTemplate.lastUpdateInstant[Long]

The instant that the Application was last updated in the FusionAuth database.

messageTemplate.localizedTemplates[Map<Locale,String (FreeMarker Enabled)>]

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

messageTemplate.name[String]

A descriptive name for the message template.

messageTemplate.type[String]

The type of the template. This will have the value SMS.

Example Response JSON for a Single Message Template
{
  "messageTemplate": {
    "data": {
      "updatedBy": "richard@fusionauth.io"
    },
    "id": "da6edb51-3d1b-40cf-b791-43b657536621",
    "insertInstant": 1619822235060,
    "lastUpdateInstant": 1619822235060,
    "defaultTemplate": "Here's your Two Factor Code: ${code}",
    "localizedTemplates": {
      "de": "Hier ist Ihr Zwei-Faktoren-Code: ${code}",
      "es": "Este es su código de dos factores: ${code}"
    },
    "name": "Default Two Factor Request",
    "type": "SMS"
  }
}

Retrieve a Message Template

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

Request

Retrieve all of the Message Templates
GET/api/message/template
Retrieve a single Message Template by Id
GET/api/message/template/{messageTemplateId}

Request Parameters

messageTemplateId[UUID]optional

The Id of the Message Template to retrieve.

Response

The response for this API contains either a single Message Template or all of the Message Templates. When you call this API with an Id the response will contain just that Message Template. When you call this API without an Id the response will contain all of the Message 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

messageTemplate.data[Object]

An object that can hold any information about the Message Template that should be persisted.

messageTemplate.defaultTemplate[[String (FreeMarker Enabled)]]

The default Message Template.

messageTemplate.id[UUID]

The unique identifier for this Message Template.

messageTemplate.insertInstant[Long]

The instant that the Application was added to the FusionAuth database.

messageTemplate.lastUpdateInstant[Long]

The instant that the Application was last updated in the FusionAuth database.

messageTemplate.localizedTemplates[Map<Locale,String (FreeMarker Enabled)>]

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

messageTemplate.name[String]

A descriptive name for the message template.

messageTemplate.type[String]

The type of the template. This will have the value SMS.

Example Response JSON for a Single Message Template
{
  "messageTemplate": {
    "data": {
      "updatedBy": "richard@fusionauth.io"
    },
    "id": "da6edb51-3d1b-40cf-b791-43b657536621",
    "insertInstant": 1619822235060,
    "lastUpdateInstant": 1619822235060,
    "defaultTemplate": "Here's your Two Factor Code: ${code}",
    "localizedTemplates": {
      "de": "Hier ist Ihr Zwei-Faktoren-Code: ${code}",
      "es": "Este es su código de dos factores: ${code}"
    },
    "name": "Default Two Factor Request",
    "type": "SMS"
  }
}

Response Body

messageTemplates[x][Array]

The list of Message Template objects.

messageTemplates[x].data[Object]

An object that can hold any information about the Message Template that should be persisted.

messageTemplates[x].defaultTemplate[[String (FreeMarker Enabled)]]

The default Message Template.

messageTemplates[x].id[UUID]

The unique identifier for this Message Template.

messageTemplates[x].insertInstant[Long]

The instant that the Application was added to the FusionAuth database.

messageTemplates[x].lastUpdateInstant[Long]

The instant that the Application was last updated in the FusionAuth database.

messageTemplates[x].localizedTemplates[Map<Locale,String (FreeMarker Enabled)>]

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

messageTemplates[x].name[String]

A descriptive name for the message template.

messageTemplates[x].type[String]

The type of the template. This will have the value SMS.

Example Response JSON for all Message Templates
{
  "messageTemplates": [
    {
      "data": {
        "updatedBy": "richard@fusionauth.io"
      },
      "id": "da6edb51-3d1b-40cf-b791-43b657536621",
      "insertInstant": 1619822235060,
      "lastUpdateInstant": 1619822235060,
      "defaultTemplate": "Here's your Two Factor Code: ${code}",
      "localizedTemplates": {
        "de": "Hier ist Ihr Zwei-Faktoren-Code: ${code}",
        "es": "Este es su código de dos factores: ${code}"
      },
      "name": "Default Two Factor Request",
      "type": "SMS"
    }
  ]
}

Update a Message Template

This API is used to update an existing Message Template.

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

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

Request

Update a Message Template by Id
PUT/api/message/template/{messageTemplateId}
PATCH/api/message/template/{messageTemplateId}

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

messageTemplateId[UUID]required

The Id of the Message Template to update.

Request Body

messageTemplate.data[Object]optional

An object that can hold any information about the Message Template that should be persisted.

messageTemplate.defaultTemplate[[String (FreeMarker Enabled)]]required

The default Message Template.

messageTemplate.localizedTemplates[[Map<Locale,String (FreeMarker Enabled)>]]optional

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

messageTemplate.name[String]required

A descriptive name for the Message Template (i.e. “Two Factor Code Message”)

messageTemplate.type[String]required

The type of the template. This must have the value SMS.

Example Request JSON
{
  "messageTemplate": {
    "data": {
      "updatedBy": "richard@fusionauth.io"
    },
    "defaultTemplate": "Here's your Two Factor Code: ${code}",
    "localizedTemplates": {
      "de": "Hier ist Ihr Zwei-Faktoren-Code: ${code}",
      "es": "Este es su código de dos factores: ${code}"
    },
    "name": "Default Two Factor Request",
    "type": "SMS"
  }
}

Response

The response for this API contains the new information for the Message 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

messageTemplate.data[Object]

An object that can hold any information about the Message Template that should be persisted.

messageTemplate.defaultTemplate[[String (FreeMarker Enabled)]]

The default Message Template.

messageTemplate.id[UUID]

The unique identifier for this Message Template.

messageTemplate.insertInstant[Long]

The instant that the Application was added to the FusionAuth database.

messageTemplate.lastUpdateInstant[Long]

The instant that the Application was last updated in the FusionAuth database.

messageTemplate.localizedTemplates[Map<Locale,String (FreeMarker Enabled)>]

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

messageTemplate.name[String]

A descriptive name for the message template.

messageTemplate.type[String]

The type of the template. This will have the value SMS.

Example Response JSON for a Single Message Template
{
  "messageTemplate": {
    "data": {
      "updatedBy": "richard@fusionauth.io"
    },
    "id": "da6edb51-3d1b-40cf-b791-43b657536621",
    "insertInstant": 1619822235060,
    "lastUpdateInstant": 1619822235060,
    "defaultTemplate": "Here's your Two Factor Code: ${code}",
    "localizedTemplates": {
      "de": "Hier ist Ihr Zwei-Faktoren-Code: ${code}",
      "es": "Este es su código de dos factores: ${code}"
    },
    "name": "Default Two Factor Request",
    "type": "SMS"
  }
}

Delete a Message Template

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

Request

Delete a Message Template By Id
DELETE/api/message/template/{messageTemplateId}

Request Parameters

messageTemplateId[UUID]required

The Id of the Message 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 a Message Template

This API is used to preview a Message Template. You pass all of the information for the Message Template in the request and a rendered version of the Message is sent back to you in the response.

FusionAuth provides sample values for the ${code} and ${user} objects when previewing. The value for ${code} will always be 123456.

The Message Template in the request does not need to be completely filled out. You can send in a partial Message Template and the response will contain only what you provided.

Request

Preview a Message Template
POST/api/message/template/preview

Request Body

locale[Locale]optional

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

messageTemplate.defaultTemplaterequired

The default Message Template to preview.

messageTemplate.localizedTemplatesoptional

The Message Template used when sending messages to users who speak other languages. This overrides the default Message Template based on the locale string passed.

messageTemplate.type[String]required

The type of the template. This must be the value SMS.

Example Preview Request JSON
{
  "messageTemplate": {
    "defaultTemplate": "Your code is: ${code}",
    "localizedTemplates": {
      "de": "Hier ist Ihr Zwei-Faktoren-Code: ${code}"
    },
    "type": "SMS"
  },
  "locale": "en"
}

Response

The response for this API contains the rendered Message 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

message.textMessage[String]

The message text.

message.type[String]

The type of the message. This will always be SMS.

email.errors

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

Example Successful Response JSON
{
  "errors": {},
  "message": {
    "textMessage": "Your code is: 123456",
    "type": "SMS"
  }
}
Example Errors Response JSON
{
  "errors": {
    "fieldErrors": {
      "messageTemplate.defaultTemplate": [
        {
          "code": "[invalidTemplate]messageTemplate.defaultTemplate",
          "message": "Freemarker processing error: [Syntax error in nameless template in line 1, column 14:\nUnexpected end of file reached. You have an unclosed \"{\".]"
        }
      ]
    }
  },
  "message": {
    "type": "SMS"
  }
}