Skip to main content
PATCH
Update an Intent

Authorizations

X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

Headers

Accept
enum<string>

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.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Path Parameters

flowId
string
required

The unique identifier for the Flow.

Required string length: 24
Pattern: ^[a-z0-9]{24}$
intentId
string
required

The unique identifier for the Intent.

Required string length: 24
Pattern: ^[a-z0-9]{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
Pattern: ^[a-z0-9]{24}$
childFeatures
Example:

false

biasTowardsParentOrChildIntents
enum<string>
Available options:
parents,
children
parentIntentId
string
Required string length: 24
Pattern: ^[a-z0-9]{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

Last modified on July 22, 2026