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

This endpoint includes the following methods:


GET

Description

Returns the subject for this email template in the specified locale.

Authentication

This endpoint supports Basic authentication. 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.

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.

Base URL

The base URL for this endpoint is your Janrain 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

Request Headers

Parameter Type Required Description
accept string Yes Indicates the format of the returned data. Allowed values are:
  • text/plain

Sample Request (curl)

This command returns the subject line of the registrationVerification email template associated with the documentation flow:


curl -X GET \
  https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/locales/en-US/mailTemplates/registrationVerification/subject \
  -H 'Authorization: Basic aW1fYV...NfbXk=' 


Running Code Samples Using Postman

The Janrain REST API code samples are written using Curl, but they can easily be run from within Postman. To use one of our code samples in Postman:

  1. Click the Copy to Clipboard button located directly beneath the code sample
  2. In Postman, click Import to display the Import dialog box.
  3. In the Import dialog box, click Paste Raw Text, and then paste in the copied code. The Import dialog box should look similar to this:

  4. Click Import, and the Curl command will be converted to a format that can be run from within Postman. All you need to do now is configure the command to work with your Janrain implementation.

Responses

200 OK

Response Example (text/plain)

Verify your email

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"
    ]
  }
}


PUT

Description

Update the subject for this email template in the specified locale.

Authentication

This endpoint supports Basic authentication. 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.

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.

Base URL

The base URL for this endpoint is your Janrain 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

Request Headers

Content-Type string required

Possible values:

  • text/plain

Request Example (text/plain)

Verify your email

Sample Request (curl)

This command updates the subject line of the registrationVerification email templates associated with the documentation flow:


curl -X PUT \
  https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/locales/en-US/mailTemplates/registrationVerification/subject \
  -H 'Authorization: Basic aW1fYV...NfbXk=' \
  -H 'Content-Type: text/plain' \
  -d '{*#settings*}{*&site_name*}{*/settings*} email verification is required'

Running Code Samples Using Postman

The Janrain REST API code samples are written using Curl, but they can easily be run from within Postman. To use one of our code samples in Postman:

  1. Click the Copy to Clipboard button located directly beneath the code sample
  2. In Postman, click Import to display the Import dialog box.
  3. In the Import dialog box, click Paste Raw Text, and then paste in the copied code. The Import dialog box should look similar to this:

  4. Click Import, and the Curl command will be converted to a format that can be run from within Postman. All you need to do now is configure the command to work with your Janrain implementation.

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"
    ]
  }
}