Modify a Localized String

Endpoint URL: {identityDomain} /config/{appId} /flows/{flow} /locales/{locale}/ strings/{string}



Description

Updates/replaces a string 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

Allowed regions are:

  • us 
  • eu 
  • au 
  • sa 
  • cn
  • sg


Request Example (application/json)


{
  "_self": "/config/4qeam8586cpkuru3ju8kj2xwdf/flows/myCoolFlow/locales/en-US/strings/poweredByAkamai",
  "name": "poweredByAkamai",
  "value": "Powered by Akamai"
}


Sample Request (curl)

The following command updates the educationCenter string associated with the en-US version of the documentation flow:


curl -X PUT \
  https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/locales/en-US/strings/educationCenter \
  -H 'Authorization: Basic aW1fYV...NfbXk=' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "educationCenter",
    "value": "The Akamai Education Center"
    }'

      Running this command in Postman


Responses

204 No Content

Successfully updated the String.

404 Not Found

String could not be found. Please check the value and try again.

Response Example (application/json)


{
  "errors": "Flow not found."
}