Updates Flow Element Definition

PUT {{baseUrl}}/survey-definitions/:surveyId/flow/:flowId

Update flow by ID.

If you're having trouble capturing single sign-on (SSO) information, make sure you've included all fields within the Options object. See this example:

"Options": {
 "maxAttempts": 3,
 "authenticationError": {
 "SystemMessage": {
 "Section": "Message example",
 "Message": "Test System Message"
 }
 } 
 "failedAuthenticationError": {
 "SystemMessage": {
 "Section": "Message example",
 "Message": "Test System Message"
 }
 } 
 "questionText": "{
 "SystemMessage": {
 "Section": "Question Text section example",
 "Message": "Question Text message example"
 }
 } 
 "allowRetake": "true",
 "loadExistingSession": "false"
}

Request Body

{"0"=>{"Type"=>"Authenticator", "PanelData"=>{"LibraryID"=>"UR_aqIVdNWJcQsmb", "PanelID"=>"CG_pxFQiRgFLPHT8", "Type"=>"Expression", "LogicType"=>"Panel"}, "FieldData"=>{"Type"=>"BooleanExpression"}, "FilterDataFields"=>"<boolean>", "SSOOptions"=>{"Type"=>"Facebook", "CaptureRespondentInfo"=>"No", "ldap"=>{"Hostname"=>"<string>", "Port"=>"<string>", "EmailField"=>"<string>", "ExternalDataReferenceField"=>"<string>", "Filter"=>"<string>", "FirstNameField"=>"<string>", "LastNameField"=>"<string>"}, "respondentMap"=>[{"key"=>"<string>", "value"=>"<string>"}, {"key"=>"<string>", "value"=>"<string>", "qui_"=>81924699.88717318, "non_a5"=>"sed aliquip sint eu ea"}, {"key"=>"<string>", "value"=>"<string>"}, {"key"=>"<string>", "value"=>"<string>"}, {"key"=>"<string>", "value"=>"<string>", "consequat02"=>"elit eiusmod"}, {"key"=>"<string>", "value"=>"<string>", "nulla___"=>"et eu velit", "pariatur829"=>49364796.85551983}, {"key"=>"<string>", "value"=>"<string>"}, {"key"=>"<string>", "value"=>"<string>", "cupidatat_e4"=>false}, {"key"=>"<string>", "value"=>"<string>", "exercitation_8a"=>3639652.005497724, "ex8"=>false}, {"key"=>"<string>", "value"=>"<string>", "non_b9"=>-44187759, "veniamd"=>80296753.10532358, "Excepteur__5"=>"dolor dolor culpa occaecat in"}, {"key"=>"<string>", "value"=>"<string>"}, {"key"=>"<string>", "value"=>"<string>"}, {"key"=>"<string>", "value"=>"<string>", "incididunt_309"=>false}, {"key"=>"<string>", "value"=>"<string>", "consequat_04"=>-23031659.502894104, "Duis_f"=>false}, {"key"=>"<string>", "value"=>"<string>"}, {"key"=>"<string>", "value"=>"<string>", "aliquip_b"=>36631985.48983401, "in3a6"=>"adipisicing irure Excepteur"}, {"key"=>"<string>", "value"=>"<string>"}, {"key"=>"<string>", "value"=>"<string>"}, {"key"=>"<string>", "value"=>"<string>", "consequat_d7f"=>"elit Excepteur", "est_1b"=>false}, {"key"=>"<string>", "value"=>"<string>", "voluptate_f8"=>35401133.75227022}], "token"=>{"EncryptionMethod"=>"BLOWFISH", "Key"=>"<string>", "Leeway"=>"<integer>", "MacMethod"=>"MD5", "BlockCipher"=>"CBC"}, "UsePanel"=>"Yes", "UsePerson"=>"Yes", "UseSSO"=>"No"}, "Options"=>{"maxAttempts"=>"<integer>", "authenticationError"=>{"SystemMessage"=>{"Section"=>"ErrorCodes", "Message"=>"EAUTH3612879413"}, "in16"=>6157626, "dolore7a"=>"anim", "do_01_"=>18973371.219287977}, "failedAuthenticationError"=>{"SystemMessage"=>{"Section"=>"ErrorCodes", "Message"=>"EAUTH77385531884"}, "cillum_475"=>-4565603.796760172}, "questionText"=>{"SystemMessage"=>{"Section"=>"ErrorCodes", "Message"=>"EAUTH09599", "quis1ee"=>"Duis minim in nulla"}}, "allowRetake"=>"<boolean>", "loadExistingSession"=>"<boolean>", "ipsume14"=>37045121.21629214, "commodo_7"=>58196950.3556751}, "FlowID"=>"FL_301", "Flow"=>{"value"=>"<Circular reference to #/components/schemas/Flow detected>"}}, "1"=>{"Type"=>"Authenticator", "PanelData"=>{"LibraryID"=>"UR_ITRG2IjGhstx5dM", "PanelID"=>"CG_khYUDVrrbmtOI", "Type"=>"Expression", "LogicType"=>"Panel"}, "FieldData"=>{"Type"=>"BooleanExpression"}, "FilterDataFields"=>"<boolean>", "SSOOptions"=>{"Type"=>"UseBrandSettings", "CaptureRespondentInfo"=>"Yes", "ldap"=>{"Hostname"=>"<string>", "Port"=>"<string>", "EmailField"=>"<string>", "ExternalDataReferenceField"=>"<string>", "Filter"=>"<string>", "FirstNameField"=>"<string>", "LastNameField"=>"<string>"}, "respondentMap"=>[{"key"=>"<string>", "value"=>"<string>"}, {"key"=>"<string>", "value"=>"<string>", "irureef8"=>true}, {"key"=>"<string>", "value"=>"<string>", "consectetur_b"=>95410943, "adipisicing_68"=>-86764361}, {"key"=>"<string>", "value"=>"<string>"}, {"key"=>"<string>", "value"=>"<string>", "cillumb8_"=>12307374.862759963}, {"key"=>"<string>", "value"=>"<string>", "ex_3"=>-59073524.91738642, "non_3"=>false}, {"key"=>"<string>", "value"=>"<string>"}, {"key"=>"<string>", "value"=>"<string>"}, {"key"=>"<string>", "value"=>"<string>"}, {"key"=>"<string>", "value"=>"<string>"}, {"key"=>"<string>", "value"=>"<string>", "sint_1"=>77840056.5789116, "cillum_9"=>-58028571.69994366, "ince"=>true}, {"key"=>"<string>", "value"=>"<string>"}, {"key"=>"<string>", "value"=>"<string>", "exercitation_5"=>false}, {"key"=>"<string>", "value"=>"<string>", "officia2"=>"in eu occaecat", "velitde"=>-61710964.54204097}, {"key"=>"<string>", "value"=>"<string>", "ex_59"=>false, "consequat_e8f"=>true}, {"key"=>"<string>", "value"=>"<string>", "do9"=>-10656426, "consectetur781"=>true}, {"key"=>"<string>", "value"=>"<string>"}, {"key"=>"<string>", "value"=>"<string>", "in6be"=>670768}, {"key"=>"<string>", "value"=>"<string>"}, {"key"=>"<string>", "value"=>"<string>", "non__f7"=>-8548670.290984496, "non8c"=>true, "in_5_1"=>false, "ut_2c"=>5387506}], "token"=>{"EncryptionMethod"=>"3DES", "Key"=>"<string>", "Leeway"=>"<integer>", "MacMethod"=>"sha512", "BlockCipher"=>"ECB"}, "UsePanel"=>"Yes", "UsePerson"=>"No", "UseSSO"=>"No"}, "Options"=>{"maxAttempts"=>"<integer>", "authenticationError"=>{"SystemMessage"=>{"Section"=>"ErrorCodes", "Message"=>"EAUTH0162"}, "mollit1e7"=>-22970112.27250749}, "failedAuthenticationError"=>{"SystemMessage"=>{"Section"=>"ErrorCodes", "Message"=>"EAUTH703253", "cillum_4"=>"minim"}, "magna_5_"=>"ex sunt occaecat laborum enim", "ida6"=>-11874893.27951257}, "questionText"=>{"SystemMessage"=>{"Section"=>"ErrorCodes", "Message"=>"EAUTH888906"}, "laborum_2"=>5304352.798892692, "ipsum_f9"=>"ex laborum"}, "allowRetake"=>"<boolean>", "loadExistingSession"=>"<boolean>"}, "FlowID"=>"FL_31557852", "Flow"=>{"value"=>"<Circular reference to #/components/schemas/Flow detected>"}}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;meta&quot;:{&quot;httpStatus&quot;:&quot;\u003cstring\u003e&quot;,&quot;requestId&quot;:&quot;\u003cstring\u003e&quot;,&quot;notice&quot;:&quot;\u003cstring\u003e&quot;}}