FormFieldTypes
Introduction
FormFieldTypes
associated to FormFields
by their key describe how inputs are displayed for the end user and which kind of information needs to be submitted and stored in FormMessageFields
when sending a Form.
Every FormFieldType
offers a generic default configuration and describes how a concrete configuration is validated when creating a FormField
.
List
Get a list of all FormFieldTypes
.
Definition
GET
/api/forms/field-types
Example Request
Example Response
Show
Show a single FormFieldType
by id
.
Definition
GET
/api/forms/field-types/{id}
Example Request
Example Response
Text
The default type for displaying a simple input field.
Key: text
Configuration
No further configuration available.
RichText
A field that is displayed as an input box and with basic RTE features.
Key rich-text
Configuration
No further configuration available.
Description
A label field to display text in the form to describe sections. This is not actually and HTML input field and will not be processed in FormMessages.
Key: description
Configuration
No further configuration available.
DateTime
A field that is displayed as DateInput and a DatePicker.
Key: datetime
Configuration
FileUpload
A field that is displayed as FileInput to upload a file from form.
Key file-upload
Configuration
Radio
A field that is displayed as radio input to select one of the configured values.
Key radio
Configuration
Checkbox
A field that is displayed as checkboxes to select one or more of the configured values.
Key checkbox
Configuration
Recipient-Select
A field to select recipients of a Form. This field type is unique for every Form and will have effect on the recipient
field of a FormMessage when it's created.
While sending FormMessages, the values of this field will be used as the receiver(s).
Key recipient-select
Configuration
You can set more than one recipient for one option by seperating the email addresses by comma
Last updated