COcognigy
Intents

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.

patch/v2.0/flows/{flowId}/intents/{intentId}

Request

Path parameters

flowIdstring required

The unique identifier for the Flow.

intentIdstring required

The unique identifier for the Intent.

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

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.

Request body

namestring
descriptionstring
conditionstring
rulesstring[]
isRejectIntentboolean
isDisabledboolean
tagsstring[]
confirmationSentencesstring[]
disambiguationSentencestring
dataobject
localeReferencestring
biasTowardsParentOrChildIntents'parents' | 'children'
parentIntentIdstring
analyticsLabelstring
overrideIntentDefaultRepliesAsExamples'on' | 'off' | 'useFlowSettings'

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

Example request

{
  "name": "OrderFood",
  "description": "Intent to order food"
}

Response

Successfully updated Intent

Changes

No recorded changes to this operation across all 1 revision of this API.