Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

An access token, bound to one account.

Path Parameters

id
string
required

Body

application/json
key
string
Maximum string length: 64
Pattern: ^[a-z][a-z0-9_]*$
label
string
Required string length: 1 - 120
type
enum<string>
Available options:
text,
number,
date,
boolean,
select,
multiselect
options
string[] | null
Maximum array length: 200
Required string length: 1 - 120
scope
enum<string>
Available options:
conversation,
customer
requiredOnClose
any
Available options:
1,
1,
true,
true,
on,
0,
0,
false,
false
description
string | null
Maximum string length: 1000
collectionPrompt
string | null
Maximum string length: 160
validationRegex
string | null
Maximum string length: 200
extraction
enum<string>
Available options:
ai,
pattern
archived
any
Available options:
1,
1,
true,
true,
on,
0,
0,
false,
false

Response

OK

data
object
required