Skip to main content
PATCH
Update Config Field Definition

Authorizations

Authorization
string
header
required

API key authentication. Get your API key from the Duvo dashboard.

Path Parameters

automation_id
string<uuid>
required

The automation's unique identifier

field_id
string<uuid>
required

The config field's unique identifier

Body

application/json
label
string

Short name for the field, shown as its row heading

Required string length: 1 - 200
key
string

New code, only for a field added to this automation that no Agent or Code step reads yet

Required string length: 1 - 120
Pattern: ^[a-z0-9][a-z0-9_]*$
question
string

New question; a reworded question gets a new version

Required string length: 1 - 2000
guidance
string | null

New guidance on what to fill in, in plain sentences, or null to remove it

Required string length: 1 - 2000
example
string | null

New example answer, or null to remove it

Required string length: 1 - 500
section
string | null

Section to move the field to the end of, or null for none

Required string length: 1 - 200
options
string[]

Select and multiSelect fields only; replaces the whole list

Required array length: 1 - 100 elements
Required string length: 1 - 200
columns
string[]

Table fields only, while the field has no answer; replaces the whole list

Required array length: 1 - 20 elements
Required string length: 1 - 100
type
enum<string>

New value type, only for a field added through the API that has no answer yet

Available options:
freeText,
identifier,
number,
select,
multiSelect,
list,
orderedList,
personList,
table
roles
string[]

Keys of the process roles whose holders answer this question; replaces the whole list, and empty means anyone

Maximum array length: 100
Required string length: 1 - 120

Response

Default Response

field
object
required