Skip to main content

Create a new column

Use this API to create a new column in the table

Request Body REQUIRED
columnName string

The name of the column

description string

The description of the column

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
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
specialType string

Possible values: [NONE, CREATED_AT, UPDATED_AT, CREATED_BY, UPDATED_BY, FOREIGN_KEY, LOOKUP_COLUMN, USER, USERS_AND_GROUPS, CONTACT]

Used to indicate if a column is special type like foreign key, lookup column, etc.

overriddenType string

Possible values: [NONE, MULTI_LINE, PHONE_NUMBER, EMAIL, URL, CURRENCY, PERCENT, DURATION, RATING, AUTONUMBER, BARCODE, QR, BUTTON]

Used to indicate if a column has custom formatting type like multi-line, phone number, url etc.

isFormula boolean

Is the column a formula column

formulaExpression string

Formula of the column if the column is of formula type

fkReferredTableId string

The id of the referred table if the column is a foreign key or lookup column

backingColumnId string

The id of the backing column if the column is a foreign key or lookup column

fkReferMultipleRows boolean

Is the foreign key column referring to multiple rows

doesBackingColumnReferMultipleRows boolean

Is the backing column referring to multiple rows

fkIsSelectionLimitedToView boolean

Is the foreign key selection limited to a view

fkLimitSelectionToViewId string

The id of the view to which the foreign key selection is limited

fkIsSelectionLimitedToCondition boolean

Is the foreign key selection limited to a condition

fkLimitSelectionToCondition string

The condition to which the foreign key selection is limited

lookupColumnReferredColumnId string

The column which the lookup column is referring to

lookupIsItemsShownLimited boolean

Is the lookup column showing limited items

lookupShownItemsLimitedType string

Possible values: [FIRST, LAST, TOP]

How are the loookup column items limited

lookupShownItemsLimitedValue int32

The value of the limit when lookup column shows limited items

isReferenceType boolean

Is the column a reference type. Applicable when the column is a QR type or Barcode Type

referredSourceColumnId string

The id of the source column if the column is a reference type

referredCDPPrimaryFieldId string

The id of the primary field of the referred CDP if the column is of CONTACT type

referredCDPId string

The id of the CDP if the column is of CONTACT type

columnAggregateType string

The type of the aggregate function

editDataLock object
tableActionLockType string

Possible values: [ALL, SPECIFIC, NONE]

tableActionLockedFlowIds string[]
manualEntryLockType string

Possible values: [ALL, SPECIFIC, NONE]

manualEntryLockedUserIds string[]
workflowScriptLockType string

Possible values: [ALL, SPECIFIC, NONE]

workflowScriptLockedFlowIds string[]
publicTableAPILockType string

Possible values: [ALL, SPECIFIC, NONE]

isIdentifier boolean

Is unique constraint applicable on columns

isMandatory boolean

Are non-null values allowed on column

barcodeFormats string[]

Allowed barcode formats if the column is of barcode type

buttonLabel string

Label of the button if the column is of button type

buttonStyle string

Style of the button if the column is of button type

customTableButtonActionType string

Possible values: [OPEN_URL, TRIGGER_FLOW, EMBED_IFRAME]

Action type of the button if the column is of button type

buttonURL string

URL of the button if the column is of button type and customTableButtonActionType = OPEN_URL | EMBED_IFRAME

buttonTriggerFlowId string

Flow id to be triggered if the column is of button type and customTableButtonActionType = TRIGGER_FLOW

buttonTriggerNodeId string

Node id to be triggered if the column is of button type and customTableButtonActionType = TRIGGER_FLOW

formattingOptions object

Formatting options for the column

Responses
200

Returns the newly created column

Schema OPTIONAL
object