/config/{app}/flows/{flow}/locales/{locale}/mailTemplates

Returns a list of transactional email templates. Transactional emails are emails automatically sent by the Identity Cloud in response to user actions; for example, when a user clicks the Forgot Password? link a resetPassword transactional email is sent to the specified email address.

This endpoint includes the following methods:

  • GET


GET

Description

Returns a list of all email templates in the specified locale. Click here for a video demo in Postman.

Authentication

This endpoint supports Basic authentication. 

How to Create an Authentication String

Base URL

The base URL for this endpoint is your Configuration API domain followed by /config/ followed by your application ID. For example, if you are in the US region and your application ID is htb8fuhxnf8e38jrzub3c7pfrr, then your base URL would be:


https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr

Allowed regions are:

  • us 
  • eu 
  • au 
  • sa 
  • cn
  • sg

Sample Request (curl)

This command returns information about all the transactional email templates associated with the en-US version of the documentation flow.


curl -G \
  -H 'Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=' \
  https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/locales/en-US/mailTemplates 

      Running this command in Postman

Responses

200 OK

Response Example (application/json)


[
  {
    "_self": "/config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow/locales/en-US/mailTemplates/reactivateAccount",
    "name": "reactivateAccount"
  },
  {
    "_self": "/config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow/locales/en-US/mailTemplates/passwordRecover",
    "name": "passwordRecover"
  },
  {
    "_self": "/config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow/locales/en-US/mailTemplates/registrationVerification",
    "name": "registrationVerification"
  },
  {
    "_self": "/config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow/locales/en-US/mailTemplates/emailAddressChanged",
    "name": "emailAddressChanged"
  }
]