Skip to main content
PATCH
/
v2.0
/
flows
/
{flowId}
/
settings
Update the Settings of a Flow
curl --request PATCH \
  --url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "continueExecutionAfterAttachedFlow": true,
  "continueExecutionAterDefaultReply": true,
  "continueExecutionAfterNegativeConfirmation": true,
  "passDefaultRepliesIntoFlow": true,
  "flowIntentMappingOrder": "joint",
  "useAttachedFlowThresholds": true,
  "useAttachedFlowContinueAfterDefaultReply": true,
  "useAttachedFlowPassDefaultRepliesIntoFlow": true,
  "implicitSlotParsing": "disabled",
  "useAttachedFlowImplicitSlotParsing": true,
  "lexiconSlotsWithSubMatches": true,
  "useIntentDefaultRepliesAsExamples": true,
  "localeSettings": {
    "localeReference": "<string>",
    "inheritFallbackLocaleModel": true
  }
}'
This response does not have an example.

Authorizations

X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

api_key
string
query
required

Supply the API Key in the Url-Query

Headers

Accept
enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Path Parameters

flowId
string
required

The Id of the Flow

Required string length: 24

Body

application/json
continueExecutionAfterAttachedFlow
boolean
continueExecutionAterDefaultReply
boolean
continueExecutionAfterNegativeConfirmation
boolean
passDefaultRepliesIntoFlow
boolean
flowIntentMappingOrder
enum<string>
Available options:
joint,
main,
attached
useAttachedFlowThresholds
boolean
useAttachedFlowContinueAfterDefaultReply
boolean
useAttachedFlowPassDefaultRepliesIntoFlow
boolean
implicitSlotParsing
enum<string>
Available options:
disabled,
full,
system,
lexicon
useAttachedFlowImplicitSlotParsing
boolean
lexiconSlotsWithSubMatches
boolean
useIntentDefaultRepliesAsExamples
boolean

Enable/Disable using default replies as training examples.

localeSettings
object

Response

Successfully updated the FlowSettings

I