Skip to main content
PATCH
/
v2.0
/
flows
/
{flowId}
/
intents
/
{intentId}
Update an Intent
curl --request PATCH \
  --url 'https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/intents/{intentId}?api_key=' \
  --header 'Authorization: Bearer <token>' \
  --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": {}
}

Authorizations

X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

api_key
string
query
required

Supply the API Key in the Url-Query

Authorization
string
header
required

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

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
intentId
string
required

The Id of the Intent

Required string length: 24

Body

application/json
name
string
Example:

"OrderFood"

description
string
Example:

"Intent to order food"

condition
string
rules
string[]
isRejectIntent
boolean
isDisabled
boolean
tags
string[]
confirmationSentences
string[]
disambiguationSentence
string
data
object
localeReference
string
Required string length: 24
childFeatures
Example:

false

biasTowardsParentOrChildIntents
enum<string>
Available options:
parents,
children
parentIntentId
string
Required string length: 24
analyticsLabel
string
overrideIntentDefaultRepliesAsExamples
enum<string>

Toggle overriding the flow setting for using default replies as training examples

Available options:
on,
off,
useFlowSettings

Response

Successfully updated Intent