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!
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 an Intent
Update an Intent in a Flow. Allows modifying of an Intentās name, description, rules, tags, and status. You can also enable or disable the Intent, mark it as a reject Intent, adjust child/parent intent relationships, and override default reply settings.
curl --request PATCH \
--url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/intents/{intentId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "OrderFood",
"description": "Intent to order food",
"condition": "<string>",
"rules": [
"<string>"
],
"isRejectIntent": true,
"isDisabled": true,
"tags": [
"<string>"
],
"confirmationSentences": [
"<string>"
],
"disambiguationSentence": "<string>",
"data": {},
"localeReference": "<string>",
"childFeatures": false,
"biasTowardsParentOrChildIntents": "parents",
"parentIntentId": "<string>",
"analyticsLabel": "<string>",
"overrideIntentDefaultRepliesAsExamples": "on"
}
'{
"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}$The unique identifier for the Intent.
24^[a-z0-9]{24}$Body
"OrderFood"
"Intent to order food"
24^[a-z0-9]{24}$false
parents, children 24^[a-z0-9]{24}$Toggle overriding the flow setting for using default replies as training examples
on, off, useFlowSettings Response
Successfully updated Intent
curl --request PATCH \
--url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/intents/{intentId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "OrderFood",
"description": "Intent to order food",
"condition": "<string>",
"rules": [
"<string>"
],
"isRejectIntent": true,
"isDisabled": true,
"tags": [
"<string>"
],
"confirmationSentences": [
"<string>"
],
"disambiguationSentence": "<string>",
"data": {},
"localeReference": "<string>",
"childFeatures": false,
"biasTowardsParentOrChildIntents": "parents",
"parentIntentId": "<string>",
"analyticsLabel": "<string>",
"overrideIntentDefaultRepliesAsExamples": "on"
}
'{
"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": {}
}