Skip to main content

Update a typebot

Update a typebot

Path Parameters
typebotId string REQUIRED
Request Body REQUIRED
typebot object REQUIRED
name string
icon string
selectedThemeTemplateId string
groups object[]
id string REQUIRED
title string REQUIRED
graphCoordinates object REQUIRED
x number REQUIRED
y number REQUIRED
blocks undefined[] REQUIRED
theme object
general object REQUIRED
font string REQUIRED
background object REQUIRED
type string REQUIRED

Possible values: [Color, Image, None]

content string
chat object REQUIRED
hostAvatar object
isEnabled boolean REQUIRED
url string
guestAvatar object
isEnabled boolean REQUIRED
url string
hostBubbles object REQUIRED
backgroundColor string REQUIRED
color string REQUIRED
guestBubbles object REQUIRED
backgroundColor string REQUIRED
color string REQUIRED
buttons object REQUIRED
backgroundColor string REQUIRED
color string REQUIRED
inputs object REQUIRED
backgroundColor string REQUIRED
color string REQUIRED
placeholderColor string REQUIRED
roundness string

Possible values: [none, medium, large]

customCss string
settings object
general object REQUIRED
isBrandingEnabled boolean REQUIRED
isTypingEmulationEnabled boolean
isInputPrefillEnabled boolean
isHideQueryParamsEnabled boolean
isNewResultOnRefreshEnabled boolean
rememberUser object
isEnabled boolean
storage string

Possible values: [session, local]

typingEmulation object REQUIRED
enabled boolean REQUIRED
speed number REQUIRED
maxDelay number REQUIRED
metadata object REQUIRED
title string
description string
imageUrl string
favIconUrl string
customHeadCode string
googleTagManagerId string
whatsApp object
credentialsId string
startCondition object
logicalOperator string REQUIRED

Possible values: [OR, AND]

comparisons object[] REQUIRED
id string REQUIRED
comparisonOperator string

Possible values: [Equal to, Not equal, Contains, Does not contain, Greater than, Less than, Is set, Is empty, Starts with, Ends with, Matches regex, Does not match regex]

value string
folderId string
variables object[]
id string REQUIRED
name string REQUIRED
value
edges object[]
id string REQUIRED
from object REQUIRED
groupId string REQUIRED
blockId string REQUIRED
itemId string
to object REQUIRED
groupId string REQUIRED
blockId string
resultsTablePreferences object
columnsOrder string[] REQUIRED
columnsVisibility object REQUIRED
columnsWidth object REQUIRED
publicId string
customDomain string
isClosed boolean
whatsAppPhoneNumberId string
updatedAt date-time

Used for checking if there is a newer version of the typebot in the database

Responses
200

Successful response

Schema
typebot object
version string

Possible values: [3, 4, 5]

id string
name string
groups object[]
id string
title string
graphCoordinates object
x number
y number
blocks undefined[]
edges object[]
id string
from object
groupId string
blockId string
itemId string
to object
groupId string
blockId string
variables object[]
id string
name string
value
theme object
general object
font string
background object
type string

Possible values: [Color, Image, None]

content string
chat object
hostAvatar object
isEnabled boolean
url string
guestAvatar object
isEnabled boolean
url string
hostBubbles object
backgroundColor string
color string
guestBubbles object
backgroundColor string
color string
buttons object
backgroundColor string
color string
inputs object
backgroundColor string
color string
placeholderColor string
roundness string

Possible values: [none, medium, large]

customCss string
selectedThemeTemplateId string
settings object
general object
isBrandingEnabled boolean
isTypingEmulationEnabled boolean
isInputPrefillEnabled boolean
isHideQueryParamsEnabled boolean
isNewResultOnRefreshEnabled boolean
rememberUser object
isEnabled boolean
storage string

Possible values: [session, local]

typingEmulation object
enabled boolean
speed number
maxDelay number
metadata object
title string
description string
imageUrl string
favIconUrl string
customHeadCode string
googleTagManagerId string
whatsApp object
credentialsId string
startCondition object
logicalOperator string

Possible values: [OR, AND]

comparisons object[]
id string
comparisonOperator string

Possible values: [Equal to, Not equal, Contains, Does not contain, Greater than, Less than, Is set, Is empty, Starts with, Ends with, Matches regex, Does not match regex]

value string
createdAt date-time
updatedAt date-time
icon string
folderId string
publicId string
customDomain string
workspaceId string
resultsTablePreferences object
columnsOrder string[]
columnsVisibility object
columnsWidth object
isArchived boolean
isClosed boolean
whatsAppPhoneNumberId string
default

Error response

Schema
message string
code string
issues object[]
message string