Update an Intent - Cognigy Documentation

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} \
  --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"
}'

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

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

Response

Successfully updated Intent

Adds a localiation for an intentAdd a localization for an [Intent](doc:intent).

⌘I

Update an Intent

curl --request PATCH \
  --url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/intents/{intentId} \
  --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"
}'

This response does not have an example.