Returns information about a specific field associated with a specific locale. Each locale represents a specific language, region, and collection of locale variant preferences; having different locales enable you to better personalize the user login and registration experience.
This endpoint includes the following methods
- GET
- PUT
GET
Returns a field definition from the flow translated into the locale specified. Includes validations.
URI Parameters
Parameter | Type | Required | Description |
---|---|---|---|
field | string | Yes | ISO language code for the locale. For example:
|
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 the optIn field associated with the documentation flow.
curl -GET \
-H 'Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=' \ https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/locales/en-US/fields/optIn
Running this command in Postman
Responses
200 OK
Response Example (application/json)
{
"_relationships": {
"forms": [
{
"_self": "/config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow/forms/editProfileForm",
"name": "editProfileForm"
}
]
},
"_self": "/config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow/fields/myCustomTextField",
"type": "text",
"name": "myCustomTextField",
"schemaAttribute": "displayName",
"label": "foo",
"tip": "foo",
"socialProfileData": "profile.displayName",
"placeholder": "foo",
"validation": [
{
"rule": "required",
"value": true,
"message": "foo"
},
{
"rule": "unique",
"value": true,
"message": "foo"
}
]
}
404 Not Found
Field could not be found. Please check the value and try again.
Response Example (application/json)
{
"errors": "Field not found."
}
PUT
Description
Updates/replaces a field in the flow.
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
Request Example (application/json)
{
"type": "text",
"name": "myCustomTextField",
"schemaAttribute": "displayName",
"label": "foo",
"tip": "foo",
"socialProfileData": "profile.displayName",
"placeholder": "foo",
"validation": [
{
"rule": "required",
"value": true,
"message": "foo"
},
{
"rule": "unique",
"value": true,
"message": "foo"
}
]
}
Sample Request (curl)
This command updates the middleName field associated with the documentation flow.
curl -X PUT \ https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/locales/en-US/fields/middleName \ -H 'Authorization: Basic
c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=' \ -H 'Content-Type: application/json' \ -d '{ "schemaAttribute": "middleName", "name": "middleName", "type": "text", "tip": "", "placeholder": "Middle Name or Middle Initial", "_relationships": { "forms": [ { "name": "ccp_editProfileForm" }, { "name": "ccp_registrationForm" }, { "name": "editProfileForm" }, { "name": "registrationForm" }, { "name": "socialRegistrationForm" } ] }, "label": "Middle Name or Middle Initial" }'
Running this command in Postman
Responses
204 No Content
Successfully updated the Field.
404 Not Found
Field could not be found. Please check the value and try again.
{
"errors": "Field not found."
}