Skip to main content
POST
Create bot field

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

Bot field name, used to reference it in flows.

Required string length: 1 - 255
type
enum<string>
required

Bot field data type.

Available options:
shortText,
email,
phoneNumber,
number,
date,
datetime,
boolean,
longText
value
string | null
required

Initial value, or null for none.

Maximum string length: 1000
description
string | null
required

Optional internal description.

Maximum string length: 1000
folderId
string | null

Folder to place the field in, or null for root-level.

Pattern: ^\d+$

Response

OK

id
string
required
name
string
required
type
enum<string>
required
Available options:
shortText,
email,
phoneNumber,
number,
date,
datetime,
boolean,
longText
value
string | null
required