Skip to main content
PUT
Edit a form field

Authorizations

X-HYS-API-Key
string
header
required

Gratona API key sent with the compatibility header X-HYS-API-Key.

Body

application/json

Field data to be updated

id
integer
client_id
string
hysform_id
integer
field_key
string
field_label
string
field_data
string | null
field_type
string
required
boolean
permissions
string
admingroup_id
integer
is_title
boolean
name_part
enum<string> | null

Recipient-form text fields only: marks the field as the record's first or last name (one of each per form). Setting or clearing it needs the manage_settings permission. Omit to keep the stored value; null clears it.

Available options:
first,
last
sortable
integer
filter
integer
field_order
integer
deleted_at
string | null
created_at
string
updated_at
string
type
string

Response

Successful operation

message
string