Skip to main content

Add variables

Use this API to add variables to the flow

Path Parameters
flowId string — REQUIRED
Request Body — REQUIRED
variables object[]

The flow variables to add (a non-empty array of ContextVariable).

questionnaireId string
variableName string
displayVariableName string
description string
isSystem boolean
defaultValue object
contextVariableType object
variableType string

Possible values: [STRING, INTEGER, REAL, BOOLEAN, DATE, TIME, DATE_TIME, IMAGE, AUDIO, VIDEO, FILE, CATEGORY, NLU_ENTITY, BLUEPRINT, LIST, SET, HASHMAP, RICHTEXT, ANY, STREAM, MAP_ENTRY, TYPE_PARAMETER, LAMBDA, FUTURE_RESULT, LIST_ITEM, SET_ITEM, ENUM_SYMBOL, CLASS_SYMBOL, VOID, UNKNOWN, ACCOUNT, MEMBER]

typeParameterName string
genericConstraintDefinitions object[]
constraintType string

Possible values: [EXTENDS, SUPER]

typeBounds string[]
lambdaDefinition (circular)
categoryValues object[]
label string
value string
description string
nluEntityId string
blueprintId string
enumId string
t1Type (circular)
t2Type (circular)
blueprintFields (circular)[]
otherDateTypeBaseType (circular)
dynamicFieldDateMapperType string

Possible values: [UNIX_TIMESTAMP_IN_SECONDS, UNIX_TIMESTAMP_IN_MILLISECONDS, UNIX_TIMESTAMP_IN_NANOSECONDS, STRING_FORMAT]

otherDateStringFormat string
metadata object
value string
nestedVariableData object
variableValidationLogs object[]
logLevel string

Possible values: [INFO, WARNING, ERROR]

canvasId string
affectedElements object[]
symbolType string

Possible values: [FLOW, NODE_CONTENT, CONTAINER, INTENT, NLU_ENTITY_TYPE, FALLBACK, REPROMPT_CONFIG, DISTRIBUTION_INSTANCE, VARIABLE, FLOW_LEVEL_VOICE_AGENT, CUSTOM_TABLE_COLUMN, CUSTOM_TABLE, CUSTOM_TABLE_VIEW, CDP_COLUMN, RESOURCE_LIBRARY_ITEM, PRIMARY_CHANNEL_SETTINGS_ID, SECONDARY_CHANNEL_SETTINGS_ID]

symbolPath string
symbolIdentifier string
errorPosition object
chipId string
startPosition int32
endPosition int32
channelTypes string[]
languageIds string[]
displayableMetadata object
referredPath string
offendingElements object[]
symbolType string

Possible values: [FLOW, NODE_CONTENT, CONTAINER, INTENT, NLU_ENTITY_TYPE, FALLBACK, REPROMPT_CONFIG, DISTRIBUTION_INSTANCE, VARIABLE, FLOW_LEVEL_VOICE_AGENT, CUSTOM_TABLE_COLUMN, CUSTOM_TABLE, CUSTOM_TABLE_VIEW, CDP_COLUMN, RESOURCE_LIBRARY_ITEM, PRIMARY_CHANNEL_SETTINGS_ID, SECONDARY_CHANNEL_SETTINGS_ID]

symbolPath string
symbolIdentifier string
errorPosition object
chipId string
startPosition int32
endPosition int32
channelTypes string[]
languageIds string[]
displayableMetadata object
referredPath string
validationLogType string
displayableMessage string
logId string
contextVariableType object
variableType string

Possible values: [STRING, INTEGER, REAL, BOOLEAN, DATE, TIME, DATE_TIME, IMAGE, AUDIO, VIDEO, FILE, CATEGORY, NLU_ENTITY, BLUEPRINT, LIST, SET, HASHMAP, RICHTEXT, ANY, STREAM, MAP_ENTRY, TYPE_PARAMETER, LAMBDA, FUTURE_RESULT, LIST_ITEM, SET_ITEM, ENUM_SYMBOL, CLASS_SYMBOL, VOID, UNKNOWN, ACCOUNT, MEMBER]

typeParameterName string
genericConstraintDefinitions object[]
constraintType string

Possible values: [EXTENDS, SUPER]

typeBounds string[]
lambdaDefinition (circular)
categoryValues object[]
label string
value string
description string
nluEntityId string
blueprintId string
enumId string
t1Type (circular)
t2Type (circular)
blueprintFields (circular)[]
otherDateTypeBaseType (circular)
dynamicFieldDateMapperType string

Possible values: [UNIX_TIMESTAMP_IN_SECONDS, UNIX_TIMESTAMP_IN_MILLISECONDS, UNIX_TIMESTAMP_IN_NANOSECONDS, STRING_FORMAT]

otherDateStringFormat string
metadata object
Responses
200

OK

Schema — OPTIONAL
object