Modify the Body of an Email Template

Endpoint URL: {identityDomain} /config/{appId} /flows/{flow} /locales/{locale} /mailTemplates/{template}/body

Description

Updates the body for this email template in the specified locale. The Content-Type header determines whether the text or html version is updated.

Respects the API Client Allow List:  No

API Client Permissions

The following table indicates the API clients that can (and the API clients that can't) be used to call this endpoint:

Authentication

This endpoint supports Basic authentication. 

How to Create an Authentication String

Request Headers

Content-Type string required

Specify the format to modify. Allowed values are:

• text/plain
• text/html

Request Example (text/plain)

Request Example (text/html)

<p>
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.
</p>
<p>
<a href=\"{*email_verification_url*}\">{*email_verification_url*}</a>
</p>

Sample Request (curl)

This command updates the body section of 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/body \
  -H 'Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=' \
  -H 'Content-Type: text/plain' \
  -d '
Welcome to {*#settings*}{*site_name*}{*/settings*}, {*#user*}{*givenName*}{*/user*}! To complete your Identity Cloud registration, point your web browser towards the URL below and verify your email address.\n\n
{*email_verification_url*} 
'

Copy to Clipboard      Running this command in Postman

Responses

204 No Content

Successfully updated the subject.

406 Not Acceptable

A GET request was made with an Accept header, or a PUT/POST request was made with a Content-Type header, that is invalid. Refer to the headers section of this method to see what types are acceptable.

Response Example (application/json)

{
  "errors": {
    "received": "application/json",
    "accepts": [
      "text/html",
      "text/plain"
    ]
  }
}

abcdefg:hijklmnop

echo -n "abcdefg:hijklmnop" | base64

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