/config/{appId}/flows/{flow}/ locales/{locale}/mailTemplates/ {template}

Returns the specified transactional email template. 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

Returns a single email template 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:

URI Parameters

Parameter	Type	Required	Description
template	string	Yes	Name of the email template to be returned.

Sample Request (curl)

This command returns information about the registrationVerification email template 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/registrationVerification

Running this command in Postman

Responses

200 OK

Response Example (application/json)


{
 "_self": "/config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow/locales/en-US/mailTemplates/registrationVerification",
 "name": "registrationVerification",
 "subject": "Verify your email",
 "textBody": "Welcome to {*#settings*}{*&site_name*}{*/settings*}, {*#user*}{*&displayName*}{*/user*}! To complete your new registration, just click on or browse to the URL below to verify this email address.\n\n{*&email_verification_url*}\n",
 "htmlBody": "<p>\nWelcome to {*#settings*}{*&site_name*}{*/settings*}, {*#user*}{*&displayName*}{*/user*}! To complete your new registration, just click on or browse to the URL below to verify this email address.\n</p>\n<p>\n<a href=\"{*email_verification_url*}\">{*email_verification_url*}</a>\n</p>\n"
}

PUT

Description

Update a single email template in the specified locale. Click here for a video demo in Postman.

Note that, when modifying emails, no single line in that email can exceed 998 characters. (Technically, the limit is 1,000 characters, but you must allow for a two-character carriage return-linefeed at the end of each line.) Can you have an email that has 5 lines, each containing 997 characters? Yes. Can you have an email that has 1 lines containing 1,001 characters? No.

Authentication

This endpoint supports Basic authentication.

How to Create an Authentication String

Base URL


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

Allowed regions are:

Request Example (application/json)


{
  "type": "new_email_verification",
  "subject": "Verify your email",
  "textBody": "Welcome to {*#settings*}{*&site_name*}{*/settings*}, {*#user*}{*&displayName*}{*/user*}! To complete your new registration, just click on or browse to the URL below to verify this email address.\n\n{*&email_verification_url*}\n",
  "htmlBody": "<p>\nWelcome to {*#settings*}{*&site_name*}{*/settings*}, {*#user*}{*&displayName*}{*/user*}! To complete your new registration, just click on or browse to the URL below to verify this email address.\n</p>\n<p>\n<a href=\"{*email_verification_url*}\">{*email_verification_url*}</a>\n</p>\n"
}

Sample Request (curl)

This command updates the registrationVerification email template associated with the documentation flow.


curl -X PUT \
  https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/locales/en-US/mailTemplates/registrationVerification \
  -H 'Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=' \
  -d '{
    "type": "new_email_verification",
    "subject": "{*#settings*}{*&site_name*}{*/settings*} email verification required",
    "textBody": "Welcome to {*#settings*}{*&site_name*}{*/settings*}, {*#user*}{*&givenName*}{*/user*}! To complete your new registration, just click on or browse to the URL below to verify this email address.\n\n{*&email_verification_url*}\n",
    "htmlBody": "\nWelcome to {*#settings*}{*site_name*}{*/settings*}, {*#user*}{*givenName*}{*/user*}! To complete your new registration, just click on or browse to the URL below to verify this email address.\n \n \n{*email_verification_url*}\n \n" 
  }'

Running this command in Postman

Responses

204 No Content

Successfully updated the email template.

How to Create an Authentication String

To create an authentication string, combine your API client ID, a colon (:), and your client secret into a single value. For example, if your client ID is abcdefg and your client secret is hijklmnop, that value would look like this:

abcdefg:hijklmnop

Next, take the string and base64 encode it. For example, on a Mac, you can base encode the string using this command:

echo -n "abcdefg:hijklmnop" | base64

If you’re running Microsoft Windows, you can encode the string by using a Windows PowerShell command similar to this:

[Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes("abcdefg:hijklmn"))

The resulting value (e.g., YWJjZGVmZzpoaWprbG1ub3A=) should be used in your authentication header.

If you are making API calls using Postman, select Basic Auth as your identification type, then use the client ID as the username and the client secret as the password.

Before you actually try your authentication string, make sure that your API client has the all the permissions (for example, the right to read user profile information) needed to complete the API call.

/config/{appId}/flows/{flow}/ locales/{locale}/mailTemplates/ {template}

GET

PUT

Running this Command in Postman

How to Create an Authentication String

Comments