Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Overview
API
- GETGet Flows
- POSTCreate a Flow
- PATCHPerform Batch Operations on Flows
- GETGet a Flow
- DELDelete a Flow
- PATCHUpdate a Flow
- POSTAdd a Locale to a Flow
- GETGet the Chart of specified Flow
- POSTCreate a Flow from a Child Node
- POSTClone a Flow
- POSTRemove a Locale from a Flow
- GETGet Flow Settings
- PATCHUpdate Flow Settings
Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Update Flow Settings
Updates Flow settings, including execution behavior, Slot parsing, Intent mapping, default replies, Locale settings, thresholds, Yes/No logic, and Slot usage.
curl --request PATCH \
--url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/settings \
--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
}
}
'{
"type": "Bad Request",
"title": "Bad Request Error",
"status": 400,
"detail": "Validation failed. Missing payload.",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}Documentation Index
Fetch the complete documentation index at: https://docs.cognigy.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Supply the API Key in the HTTP-Header
Headers
The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.
application/json, application/hal+json, application/xml, text/xml, text/csv Path Parameters
The unique identifier for the Flow.
24^[a-z0-9]{24}$Body
joint, main, attached disabled, full, system, lexicon Enable/Disable using default replies as training examples.
Show child attributes
Show child attributes
Response
Successfully updated the FlowSettings
curl --request PATCH \
--url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/settings \
--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
}
}
'{
"type": "Bad Request",
"title": "Bad Request Error",
"status": 400,
"detail": "Validation failed. Missing payload.",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}