/config/{app}/flows/{flow}/strings

This endpoint includes the following methods:


GET

Description

Returns a list of Strings defined 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 Janrain 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 all the strings associated with the documentation flow:


curl -X GET \
  https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/strings \
  -H 'Authorization: Basic aW1fYV...NfbXk=' \
  -H 'Content-Type: application/json' 


      Running this command in Postman

Responses

200 OK

Response Example (application/json)


[
  {
    "_self": "/config/4qeam8586cpkuru3ju8kj2xwdf/flows/myCoolFlow/strings/emailAddressData",
    "name": "emailAddressData"
  },
  {
    "_self": "/config/4qeam8586cpkuru3ju8kj2xwdf/flows/myCoolFlow/strings/poweredByJanrain",
    "name": "poweredByJanrain"
  }
]

404 Not Found

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

Response Example (application/json)


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


POST

Description

Adds a String to the flow. Strings must contain either schemaId or value. Do not provide both.

Authentication

This endpoint supports Basic authentication. 

How to Create an Authentication String

Base URL

The base URL for this endpoint is your Janrain 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/strings/myCoolString",
  "name": "myCoolString",
  "schemaId": "myCoolAttribute",
  "value": {
    "_self": "/config/4qeam8586cpkuru3ju8kj2xwdf/flows/myCoolFlow/strings/myCoolString",
    "key": "a0861174cd5d46eb65d38ee3ec137d55",
    "path": "strings.myCoolString.value",
    "values": {
      "en-US": "This is a cool string"
    }
  }
}

Sample Request (curl)

This command adds a new string to the documentation flow:


curl -X POST \
  https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/strings \
  -H 'Authorization: Basic aW1fYV...NfbXk=' \
  -H 'Content-Type: application/json' \
  -d '{
  "_self": "/config/4qeam8586cpkuru3ju8kj2xwdf/flows/myCoolFlow/strings/janrainEducationCenter",
  "name": "janrainEducationCenter",
  "schemaId": "janrainEducationCenter",
  "value": {
    "_self": "/config/4qeam8586cpkuru3ju8kj2xwdf/flows/myCoolFlow/strings/janrainEducationCenter",
    "key": "a0861174cd5d46eb65d38ee3ec137d55",
    "path": "strings.janrainEducationCenter.value",
    "values": {
      "en-US": "Janrain Education Center"
    }
  }
}'
      Running this command in Postman

Responses

201 Created

Successfully created a new string.

Response Headers

Location string

The location of the newly-created string.

Example: Location: /config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow/strings/myCoolString

404 Not Found

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

Response Example (application/json)


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