Data Fields

Add a new data field

post/data-field

Request

  • Base URL: https://developer.meetergo.com (the document declares no server; this is the origin it was published from)
  • URL: https://developer.meetergo.com/data-field
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • API key in header x-meetergo-api-user-id

Query parameters

personalboolean

Request body

labelstring required
fieldType'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' | 'testimonial' | 'faq' | 'countdown' | 'loading' | 'quiz-reveal' | 'logos' | 'checklist' | 'html' | 'address' required
target'email' | 'firstname' | 'lastname' | 'fullname' | 'phone' | 'marketing_consent' | 'other' required
defaultboolean required
requiredboolean required
hiddenboolean required
hideUntilChangeboolean
defaultValuestring nullable
placeholderstring
minnumber

Used by number field

maxnumber

Used by number field

showInfoboxboolean
infoboxTextstring
useMarkdownboolean

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

requireSignatureOtpboolean
helpTextstring

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

displayStyleobject

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

conditionsobject nullable

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

headingLevelnumber

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

Response

idnumber required
labelstring required
namestring required
target'email' | 'firstname' | 'lastname' | 'fullname' | 'phone' | 'marketing_consent' | 'other' required
fieldType'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' | 'testimonial' | 'faq' | 'countdown' | 'loading' | 'quiz-reveal' | 'logos' | 'checklist' | 'html' | 'address' required
ordernumber required

Where this field sits when its values are read back on a record.

A contact's custom fields are a jsonb bag keyed by field name, so the card showing them had no order but the one values happened to be written in — which put a postcode above the street it belongs under. Ordering the definitions gives every surface reading additionalData one answer. Lower first; ties fall back to id, so untouched companies keep the order they already see.

defaultboolean required
requiredboolean required
hiddenboolean required
hideUntilChangeboolean required
mutableboolean required
defaultValuestring
placeholderstring
hubspotContactFieldstring
hubspotCompanyFieldstring
smartWeContactFieldstring
smartWeCompanyFieldstring
pipedriveContactFieldstring
closeContactFieldstring
salesforceContactFieldstring
salesforceLeadFieldstring
salesforceCaseFieldstring
salesforceOpportunityFieldstring
salesforceAccountFieldstring
createdAtstring date-time required
updatedAtstring date-time required
deletedAtstring nullable
helpTextstring

Optional help text shown below the field in the booking form. Provides additional guidance to users filling out the form.

displayStyleobject

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

conditionsobject nullable

Conditional visibility expression. When set, the field is only shown to the visitor when the expression evaluates to true against current form values. Uses the same Expression/ExpressionCondition structure as routing rules.

headingLevelnumber

Heading level for heading fields (1–6). Defaults to 2 (renders as <h2>).

signingPausedboolean

Computed per request when a public form is served — not persisted. Populated by PublicFormController.withSigningAvailability.

True when the owning company has used this month's signature allowance, so the renderer shows this field as temporarily unable to take a signature instead of a signature pad. The rest of the form still renders and still submits: these forms are lead capture, and losing the lead would cost the owner far more than the unsigned document.

showInfoboxboolean required

Only for data fields of type slide, enable to show an infobox.

infoboxTextstring

Only for data fields of type slide, custom infobox text.

companyIdstring required
evalancheFieldIdstring
klicktippFieldIdstring
minnumber

Currently used by number field as min value. For string field, it is minimum amount of characters.

maxnumber
stylenumber

For Phone Number field - used to set the style of phone input. 0 - Simple (Default) 1 - With country code picker

defaultCountryCodestring

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.

useMarkdownboolean required

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

requireSignatureOtpboolean required

When true, the signer must verify their email via OTP before the signature canvas is unlocked.

Changes

No recorded changes to this operation across all 1 revision of this API.