Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

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

Body

application/json
key
string
required

Starts with a letter; letters, numbers and underscores only. Fixed once created.

Pattern: ^[A-Za-z][A-Za-z0-9_]{0,99}$
Example:

"plan_tier"

label
string
required
Required string length: 1 - 100
valueType
enum<string>
required
Available options:
TEXT,
NUMBER,
BOOLEAN,
DATE,
PHONE_NUMBER,
EMAIL,
CURRENCY
extract
boolean
required

Whether conversations fill this field

description
string | null

What the agent listens for in a conversation. Required when extract is true.

Required string length: 1 - 500

Response

Created field

data
object
required