Endpoint URL: {identityDomain} /config/{appId} /flows/{flow} /locales/{locale} /fields
Description
Adds a field to the flow. Works just like /config/{app}/flows/{flow}/fields/{field} except translatable values are accepted in the locale specified. The schemaAttribute must be a dot-separated path to an existing schema attribute.
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:
owner | access_issuer | direct_access | direct_read_access | login_client |
Yes | No | Yes | No | No |
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 adds a new field (userCountry) to the en-US version of the documentation flow.
curl -X POST \ https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/locales/en-US/fields \ -H 'Authorization: Basic
c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=' \ -H 'Content-Type: application/json' \ -d '{ "type": "text", "name": "userCountry", "schemaAttribute": "primaryAddress.country", "label": "Country", "tip": "The country where the user lives.", "socialProfileData": "profile.primaryAddress.country", "placeholder": "Country" } '
Running this command in Postman
Responses
201 Created
Successfully created a new field.
Response Headers
Location string
The location of the newly-created field.
Example: Location: /config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow/fields/myField
404 Not Found
Flow could not be found. Please check the value and try again.
Response Example (application/json)
{
"errors": "Flow not found."
}