The GET method returns the subject portion of the specified transactional email template, while the PUT method enables you to modify the email subject line. 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
- PUT
GET
Description
Returns the subject for this email template in the specified locale.
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
Request Headers
| Parameter | Type | Required | Description |
|---|---|---|---|
| accept | string | Yes | Indicates the format of the returned data. Allowed values are:
|
Sample Request (curl)
This command returns the subject line of the registrationVerification email template associated with the documentation flow.
curl -G \-H 'Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=' \ https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/locales/en-US/mailTemplates/registrationVerification/subject
Running this command in Postman
Responses
200 OK
Response Example (text/plain)
Verify your email406 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.
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
Request Headers
Content-Type
- string
- required
Possible values:
- text/plain
Request Example (text/plain)
Sample Request (curl)
This command updates the subject line of the registrationVerification email templates associated with the documentation flow.
curl -X PUT \-H 'Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=' \https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/locales/en-US/mailTemplates/registrationVerification/subject \-H 'Content-Type: text/plain' \ -d '{*#settings*}{*&site_name*}{*/settings*} email verification is required'
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"
]
}
}
