Endpoint URL: {identityDomain} /config/{appId} /flows/{flow} /fields/{field}
Description
Updates/replaces a field in the flow.
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": {
"key": "b6ced670-7140-4446-9839-da3474860b1a"
},
"tip": {
"key": "8b93448a-6f00-448c-952b-0f1536107cf7"
},
"socialProfileData": "profile.displayName",
"placeholder": {
"key": "6e15067b-2ca5-43c3-af96-930766d63375"
},
"validation": [
{
"rule": "required",
"value": true,
"message": {
"key": "bb2b21a1-98df-4dce-84f7-534013c46225"
}
},
{
"rule": "unique",
"value": true,
"message": {
"key": "63f7c18f-521a-4b4f-94c4-0b04b870c82e"
}
}
]
}
Sample Request (curl)
This command updates the userFullName field associated with the documentation flow.
curl -X PUT \ https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/fields/userFullName \ -H 'Authorization: Basic
c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=' \ -H 'Content-Type: application/json' \ -d '{ "type": "text", "schemaAttribute": "familyName", "name": "userFullName" }'
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.
Response Example (application/json)
{
"errors": "Field not found."
}