Skip to main content
PATCH
Update data field

Authorizations

Authorization
string
header
required

Bearer token: a Platform API Key (format: ak_live::) or a Personal Access Token (format: rgo-...). PATs always act as the token owner.

Path Parameters

fieldId
number
required

Body

application/json
label
string
fieldType
enum<string>
Available options:
email,
phone,
text-single,
text-multi,
number,
select,
checkbox-single,
checkbox-multi,
radio,
slide,
url,
file,
date-of-birth,
yes-no,
rating,
scale,
signature,
date,
time,
image,
heading,
separator,
page-break,
contact,
bank-details,
license-plate,
info-text,
info-image,
info-video,
currency,
location,
pdf-template,
file-download
target
enum<string>
Available options:
email,
firstname,
lastname,
fullname,
phone,
other
locales
object[]
default
boolean
required
boolean
hidden
boolean
hideUntilChange
boolean
defaultValue
string
placeholder
string
options
object[]
slideOptions
object
fileFieldOptions
object

Configuration for file upload fields. Required when fieldType is 'file'.

min
number

Used by number field

max
number

Used by number field

showInfobox
boolean
infoboxText
string
useMarkdown
boolean
default:false

When true, field.label is rendered through markdown-it (html: false). Allows bold, italic, code, and links in field labels.

requireSignatureOtp
boolean
default:false
contactOptions
object

Configuration for contact composite fields. Controls which sub-inputs (name, email, phone, address) are shown.

helpText
string

Optional help text shown below the field in the booking form.

bankDetailsOptions
object

Configuration for bank details composite fields. Controls which optional sub-inputs (BIC, account holder, signature) are shown.

licensePlateOptions
object

Configuration for license plate fields. Controls country format validation.

displayStyle
object

Controls how options are displayed for radio/checkbox/select fields. 'default' - Standard list view 'card' - Card grid with optional icons

conditions
object | null

Conditional visibility expression. When set, the field is only shown when the expression evaluates to true against the current form values.

headingLevel
number

Heading level for heading fields (1–6). Defaults to 2 (

).

pdfTemplateOptions
object

Configuration for PDF template fields. Holds the template PDF reference and pdfme schema JSON.

fileDownloadOptions
object

Configuration for file download display fields. Holds IDs of library files to offer for download.

name
string
hubspotContactField
string
hubspotCompanyField
string
pipedriveContactField
string
closeContactField
string
salesforceContactField
string
salesforceLeadField
string
salesforceCaseField
string
salesforceOpportunityField
string
salesforceAccountField
string
evalancheFieldId
string
klicktippFieldId
string
style
number
defaultCountryCode
string

For Phone Number field - default country code (e.g., "+1", "+49", "+44"). Used when style is WITH_COUNTRY_CODE_PICKER to set the initial country selection.

Response