API Field Reference

This page lists all the fields that you can write to (and read from) via the propform API – along with the expected data type or format for each. The list is generated directly from propform’s validation rules and is therefore always up to date.

> You can view the current value of a field at any time using GET /forms/{id} or GET /fields/{id}. This page supplements that with the input format, which a simple read call does not reveal.

Data formats & special features

A few formats are not self-explanatory – here are the main pitfalls:

Yes/No fields should be accepted as true/false (recommended) or 1/0.
Colours are hex values including the hash symbol, e.g. #0d6efd.
datalist (a field’s selection values) should be specified as a semicolon-separated list: Rot;Grün;Blau.
List fields (JSON array) such as webhook_modules must be provided as a genuine JSON array, e.g. ["address","estate"].
Passwords (e.g. form_password, create_file_owner_password) are write-only: you can set them, but they never appear in responses.
custom_slug must be unique within your account – otherwise use 422.
With PATCH, all fields are optional: only the data you include will be changed. Any field sent empty, however, will be actively cleared.
Non-writable (and therefore not listed here): id, slug, user_id, template flags and counters.
Element lists of the mini forms (relation_subform_elements for the relation field, searchcriteria_list_subform_elements for the search profile widget) are JSON arrays of objects; the allowed keys per entry are listed as ↳ rows directly below the list field. type is field (with name = onOffice field name) or a layout element (headline, description, dividingline, for the relation field also collapsible, each with text). In the search profile widget, default, default_von and default_bis apply to new search profiles only (multi-value fields as a semicolon list, yes/no as "1"/"0", all values as text); min, max, step and allow_input belong to the slider display.

For field properties relating to onOffice (onoffice_field_name), you can find the valid values via GET /onoffice/fields.

Form settings

`Field`	Type / format
`accent_color`	Text (max. 7)
`access_password`	Text (max. 255)
`access_password_enabled`	Yes/No
`access_password_error`	Text (max. 500)
`access_password_label`	Text (max. 255)
`active`	Yes/No
`address_duplicate_check`	Yes/No
`address_duplicate_check_fields`	Text (max. 1000)
`address_filter`	Text (max. 50)
`agentslog_Absagegrund`	Text (max. 255)
`agentslog_Aktionsart`	Text (max. 255)
`agentslog_Aktionstyp`	Text (max. 255)
`agentslog_Bemerkung`	Text (max. 20000)
`agentslog_Benutzer_nr`	Text (max. 255)
`agentslog_Beratungsebene`	Text (max. 1)
`agentslog_Dauer`	Number
`agentslog_HerkunftKontakt`	Text (max. 255)
`agentslog_Kosten`	Number
`agentslog_merkmal`	Text (max. 255)
`ai_voice_fill_active`	Yes/No
`auto_send_form`	Yes/No
`background_color`	Text (max. 7)
`background_image_blur`	Number
`background_image_brightness`	Number
`background_image_contrast`	Number
`background_image_greyscale`	Number
`background_image_url`	URL
`card_background_blur`	Number
`card_background_color`	Text (max. 7)
`card_background_opacity`	Number
`card_corners`	Text (max. 20)
`card_font_color`	Text (max. 7)
`card_shadow`	Text (max. 255)
`create_file`	Yes/No
`create_file_certificate_contact_info`	Text (max. 128)
`create_file_certificate_encryption`	One of: `none`, `default`, `user`
`create_file_certificate_encryption_permissions`	List (JSON array)
`create_file_certificate_location`	Text (max. 128)
`create_file_certificate_name`	Text (max. 64)
`create_file_certificate_reason`	Text (max. 128)
`create_file_certificate_type`	One of: `none`, `default`, `user`
`create_file_certification_level`	One of: `0`, `1`, `2`
`create_file_destination`	One of: `FormAddress`, `FormEstate`
`create_file_destination_field`	Text (max. 50)
`create_file_documentattribute`	Text (max. 50)
`create_file_name`	Text (max. 100)
`create_file_owner_password`	Text (max. 200)
`create_file_pdf_exposes`	Yes/No
`create_file_pdfexposeidentifiers`	Text (max. 16000)
`create_file_permissions`	List (JSON array)
`create_file_sign_pdf`	Yes/No
`create_file_user_password`	Text (max. 200)
`custom_slug`	Text (unique per account)
`default_imprint`	Yes/No
`default_styling`	Yes/No
`description`	Text (max. 65535)
`disable_submit_button`	Yes/No
`enable_onoffice_prefill`	Yes/No
`enable_prefill_with_UUIDs`	Yes/No
`estate_duplicate_check_objektnr_extern`	Yes/No
`estate_duplicate_check_objektnr_extern_exists`	Yes/No
`estate_filter`	Text (max. 50)
`etracker_active`	Yes/No
`etracker_id`	Text (max. 15)
`execute_webhooks`	Yes/No
`expiration_date_required`	Yes/No
`expiration_date_required_encrypted`	Yes/No
`facebook_pixel_active`	Yes/No
`facebook_pixel_id`	Text (max. 25)
`favicon_url`	URL
`font_color_submit`	Text (max. 7)
`form_groups`	List of group IDs
`form_password`	Text (max. 255)
`form_password_error`	Text (max. 500)
`form_template`	Yes/No
`form_width`	Number
`google_font_name`	One of: `Barlow`, `Comfortaa`, `Concert One`, `Lato`, `Merriweather`, `Monoton`, `Montserrat`, `Nothing You Could Do`, `Noto Sans`, `Noto Serif`, `Oooh Baby`, `Open Sans`, `Oswald`, `Permanent Marker`, `Poiret One`, `Prompt`, `PT Sans`, `Raleway`, `Roboto`, `Rubik`, `Rubik Dirt`, `Slabo 13px`, `Slabo 27px`, `Source Sans Pro`, `Work Sans`, `Ubuntu`, `Poppins`, `Source Serif 4`, `Baskervville`, `Inter`
`google_tag_manager_active`	Yes/No
`google_tag_manager_id`	Text (max. 15)
`headline_font`	One of: `Barlow`, `Comfortaa`, `Concert One`, `Lato`, `Merriweather`, `Monoton`, `Montserrat`, `Nothing You Could Do`, `Noto Sans`, `Noto Serif`, `Oooh Baby`, `Open Sans`, `Oswald`, `Permanent Marker`, `Poiret One`, `Prompt`, `PT Sans`, `Raleway`, `Roboto`, `Rubik`, `Rubik Dirt`, `Slabo 13px`, `Slabo 27px`, `Source Sans Pro`, `Work Sans`, `Ubuntu`, `Poppins`, `Source Serif 4`, `Baskervville`, `Inter`
`headline_font_color`	Text (max. 7)
`headline_font_size`	Number
`homepage_url`	URL
`iframe_options`	List (JSON array)
`iframe_script_version`	Text (max. 50)
`imprint_line_1`	Text (max. 255)
`imprint_line_2`	Text (max. 255)
`imprint_line_3`	Text (max. 255)
`imprint_line_4`	Text (max. 255)
`imprint_line_5`	Text (max. 255)
`imprint_url`	URL
`internal_note`	Text (max. 65535)
`internal_title`	Text
`ip_whitelist`	Yes/No
`ip_whitelist_ips`	Text (max. 2000)
`load_related_address_dataset`	One of: `none`, `OwnerEstate`, `SecondOwnerEstate`, `ThirdOwnerEstate`, `BuyerEstate`, `SecondBuyerEstate`, `ThirdBuyerEstate`, `RenterEstate`, `SecondRenterEstate`, `ThirdRenterEstate`, `TippEstate`, `ContactPersonBroker`, `ContactPerson`, `SecondContactPerson`, `ThirdContactPerson`, `SupervisorEstate`
`load_related_address_dataset_kontaktart`	Text (max. 50)
`load_related_estate_dataset`	One of: `none`, `OwnedEstate`, `SecondOwnedEstate`, `ThirdOwnedEstate`, `BoughtEstate`, `SecondBoughtEstate`, `ThirdBoughtEstate`, `RentedEstate`, `SecondRentedEstate`, `ThirdRentedEstate`, `TippedEstate`, `SecondTippedEstate`, `ThirdTippedEstate`
`loaded_datasets_required`	Yes/No
`loaded_datasets_required_address`	Yes/No
`loaded_datasets_required_estate`	Yes/No
`logo_url`	URL
`multistep_active`	Yes/No
`multistep_back_label`	Text (max. 100)
`multistep_continue_label`	Text (max. 100)
`multistep_show_back_button`	Yes/No
`multistep_show_progress`	Yes/No
`password_required`	Yes/No
`pre_agentslog_Absagegrund`	Text (max. 255)
`pre_agentslog_Aktionsart`	Text (max. 255)
`pre_agentslog_Aktionstyp`	Text (max. 255)
`pre_agentslog_Bemerkung`	Text (max. 20000)
`pre_agentslog_Benutzer_nr`	Text (max. 255)
`pre_agentslog_Beratungsebene`	Text (max. 1)
`pre_agentslog_Dauer`	Number
`pre_agentslog_HerkunftKontakt`	Text (max. 255)
`pre_agentslog_Kosten`	Number
`pre_agentslog_merkmal`	Text (max. 255)
`pre_write_agentslog`	Yes/No
`privacypolicy_url`	URL
`redirect`	Text (max. 65535)
`redirect_append_address_uuid`	Yes/No
`redirect_append_address_uuid_type`	One of: `FormAddress`, `OwnerEstate`, `SecondOwnerEstate`, `ThirdOwnerEstate`, `BuyerEstate`, `SecondBuyerEstate`, `ThirdBuyerEstate`, `RenterEstate`, `SecondRenterEstate`, `ThirdRenterEstate`, `TippEstate`, `ContactPersonBroker`, `ContactPerson`, `SecondContactPerson`, `ThirdContactPerson`, `SupervisorEstate`, `SupervisorAddress`
`redirect_append_address_uuid_type_kontaktart`	Text (max. 50)
`redirect_append_estate_uuid`	Yes/No
`redirect_append_estate_uuid_type`	One of: `FormEstate`, `OwnedEstate`, `SecondOwnedEstate`, `ThirdOwnedEstate`, `BoughtEstate`, `SecondBoughtEstate`, `ThirdBoughtEstate`, `RentedEstate`, `SecondRentedEstate`, `ThirdRentedEstate`, `TippedEstate`, `SecondTippedEstate`, `ThirdTippedEstate`
`relation_estate`	Text (max. 100)
`selling_price_offer_address_field`	Text (max. 50)
`send_submission_mail`	Yes/No
`staff_allowed_group_ids`	List (JSON array)
`staff_allowed_member_ids`	List (JSON array)
`staff_only_enabled`	Yes/No
`submission_mail_address`	Email
`submit_button_label`	Text (max. 255)
`submit_open`	Text (max. 10)
`submit_spinner_label`	Text (max. 255)
`task_Art`	Text (max. 255)
`task_Aufgabe`	Text (max. 10000)
`task_Bearbeiter`	Text (max. 255)
`task_Betreff`	Text (max. 255)
`task_Prio`	Text (max. 255)
`task_Status`	Text (max. 255)
`task_Verantwortung`	Text (max. 255)
`thankyou_headline`	Text (max. 200)
`thankyou_rules`	List (JSON array)
`thankyou_rules_active`	Yes/No
`thankyou_text`	Text (max. 5000)
`title`	Text (max. 255)
`webhook_modules`	List (JSON array)
`write_agentslog`	Yes/No
`write_agentslog_with_files`	Yes/No
`write_multiselect_values`	List (JSON array)
`write_selling_price_offer_to_field`	Yes/No
`write_task`	Yes/No
`write_task_with_files`	Yes/No
`write_values`	Yes/No
`write_values_in_address_or_estate`	JSON

Email settings (confirmation email)

`Field`	Type / format
`attach_document_attributes`	Yes/No
`attach_document_attributes_2`	Yes/No
`attach_pdf_exposes`	Yes/No
`attach_pdf_exposes_2`	Yes/No
`attach_pdf_forms`	Yes/No
`attach_pdf_forms_2`	Yes/No
`attach_pdf_letters`	Yes/No
`attach_pdf_letters_2`	Yes/No
`attach_uploaded_files`	Yes/No
`attach_uploaded_files_2`	Yes/No
`attach_webexposes`	Yes/No
`attach_webexposes_2`	Yes/No
`bcc`	Text
`bcc_2`	Text
`bcc_kontaktart`	Text
`bcc_kontaktart_2`	Text
`bcc_switch`	Text
`bcc_switch_2`	Text
`body`	Text
`body_2`	Text
`cc`	Text
`cc_2`	Text
`cc_kontaktart`	Text
`cc_kontaktart_2`	Text
`cc_switch`	Text
`cc_switch_2`	Text
`displayName`	Text
`displayName_2`	Text
`documentattributes`	Text
`documentattributes_2`	Text
`emailidentity`	Text (max. 100)
`emailidentity_2`	Text (max. 100)
`macro_resolve`	Text
`macro_resolve_2`	Text
`pdfexposeidentifiers`	Text
`pdfexposeidentifiers_2`	Text
`pdfformids`	Text
`pdfformids_2`	Text
`pdfletterids`	Text
`pdfletterids_2`	Text
`receiver`	Text
`receiver_2`	Text
`receiver_kontaktart`	Text
`receiver_kontaktart_2`	Text
`receiver_switch`	Text
`receiver_switch_2`	Text
`replyto`	Text
`replyto_2`	Text
`send_email_via_onoffice`	Yes/No
`send_email_via_onoffice_2`	Yes/No
`subject`	Text
`subject_2`	Text
`templateid`	Text
`templateid_2`	Text
`useHtml`	Yes/No
`useHtml_2`	Yes/No
`webexposeids`	Text
`webexposeids_2`	Text

ChatGPT settings

`Field`	Type / format
`chat_gpt_active`	Yes/No
`chat_gpt_assistant_content`	Text (max. 65000)
`chat_gpt_frequency_penalty`	Number
`chat_gpt_max_tokens`	Number
`chat_gpt_model`	Text (max. 50)
`chat_gpt_n`	Number
`chat_gpt_onoffice_fieldname`	Text (max. 50)
`chat_gpt_onoffice_module`	Text (max. 50)
`chat_gpt_presence_penalty`	Number
`chat_gpt_stop`	Text (max. 100)
`chat_gpt_system_content`	Text (max. 65000)
`chat_gpt_temperature`	Number
`chat_gpt_top_p`	Number
`chat_gpt_user_content`	Text (max. 65000)
`chat_gpt_user_content2`	Text (max. 65000)

Field properties

`Field`	Type / format
`address_live_search`	Yes/No
`address_live_search_prefill`	Yes/No
`address_related_suggestions`	List (JSON array)
`autocomplete`	Text (max. 50)
`break_gtm_step_name`	Text (max. 50)
`calendar_date_mode`	Text (max. 10)
`calendar_disable_weekends`	Yes/No
`calendar_max_date`	Text
`calendar_min_date`	Text
`collapsible_section_status`	Text (max. 50)
`datalist`	Text (max. 65535)
`default_value`	Text (max. 65535)
`disabled`	Yes/No
`display_variant`	Text (max. 50)
`documentAttribute`	Text (max. 255)
`download_field_create_file_pdfexposeidentifier`	Text (max. 100)
`download_field_create_file_type`	Text (max. 50)
`download_field_document_attribute_contains`	Text (max. 100)
`download_field_estate_document_attribute`	Text (max. 100)
`download_field_estate_file_title_contains`	Text (max. 100)
`download_field_estate_file_type`	Text (max. 50)
`download_field_file_name_contains`	Text (max. 100)
`download_field_file_name_downloaded_file`	Text (max. 1000)
`download_field_hide_when_empty`	Yes/No
`download_field_selector`	Text (max. 50)
`download_field_url`	Text (max. 1000)
`download_field_write_agentslog`	Yes/No
`download_field_write_agentslog_aktionsart`	Text
`download_field_write_agentslog_aktionstyp`	Text
`download_field_write_agentslog_merkmal`	Text
`download_field_write_agentslog_with_files`	Yes/No
`enable_prefill_with_url_parameters`	Yes/No
`estate_live_search`	Yes/No
`estate_live_search_prefill`	Yes/No
`estate_related_suggestions`	List (JSON array)
`force_value`	Text (max. 65535)
`gtm_push_value`	Yes/No
`half_size`	Yes/No
`hidden`	Yes/No
`hint`	Text (max. 65535)
`iframe_height`	Text (max. 10)
`iframe_height_auto`	Yes/No
`iframe_parameters`	List (JSON array)
`iframe_submit_open`	Text (max. 10)
`iframe_url`	Text (max. 65535)
`image_url`	Text (max. 65535)
`label`	Text (max. 65535)
`limit_value`	Text (max. 65535)
`link_append_address_uuid`	Yes/No
`link_append_address_uuid_type`	One of: `FormAddress`, `OwnerEstate`, `SecondOwnerEstate`, `ThirdOwnerEstate`, `BuyerEstate`, `SecondBuyerEstate`, `ThirdBuyerEstate`, `RenterEstate`, `SecondRenterEstate`, `ThirdRenterEstate`, `TippEstate`, `ContactPersonBroker`, `ContactPerson`, `SecondContactPerson`, `ThirdContactPerson`, `SupervisorEstate`, `SupervisorAddress`
`link_append_address_uuid_type_kontaktart`	Text (max. 50)
`link_append_estate_uuid`	Yes/No
`link_append_estate_uuid_type`	One of: `FormEstate`, `OwnedEstate`, `SecondOwnedEstate`, `ThirdOwnedEstate`, `BoughtEstate`, `SecondBoughtEstate`, `ThirdBoughtEstate`, `RentedEstate`, `SecondRentedEstate`, `ThirdRentedEstate`, `TippedEstate`, `SecondTippedEstate`, `ThirdTippedEstate`
`link_button_link`	Text (max. 65535)
`link_open_in_new_tab`	Yes/No
`max_value`	Number
`min_value`	Number
`min_value_onoffice`	Yes/No
`multiselect_close_on_selection`	Yes/No
`multiselect_max_selected`	Number
`multiselect_min_selected`	Number
`multiselect_mode`	Text (max. 50)
`multiselect_open_on_typing`	Yes/No
`number_stepper`	Yes/No
`number_stepper_step`	Number
`number_unit`	Text (max. 25)
`onoffice_field_name`	Text
`onoffice_module`	Text
`placeholder`	Text (max. 65535)
`range_default_bis`	Text (max. 50)
`range_default_von`	Text (max. 50)
`rating_custom_icon`	Text (max. 100)
`rating_symbol`	Text (max. 20)
`read_only`	Yes/No
`relation_advisor_mode`	One of: `anchor`, `fixed`
`relation_advisor_user_id`	Text (max. 30)
`relation_allow_create`	Yes/No
`relation_allow_edit`	Yes/No
`relation_allow_remove`	Yes/No
`relation_allow_search`	Yes/No
`relation_anchor_module`	One of: `estate`, `address`
`relation_auto_open_create`	Yes/No
`relation_duplicate_check`	Yes/No
`relation_duplicate_check_fields`	List (JSON array)
`relation_show_existing`	Yes/No
`relation_subform_elements`	List (JSON array)
↳ `half`	Yes/No
↳ `name`	Text (max. 100)
↳ `required`	Yes/No
↳ `text`	Text (max. 65535)
↳ `type`	One of: `field`, `headline`, `description`, `dividingline`, `collapsible`
`relation_type`	One of: `estate:address:owner`, `estate:address:buyer`, `estate:address:renter`, `estate:address:tenant`, `estate:address:contactPerson`, `estate:address:contactPersonAll`, `estate:address:interested`, `address:estate:tipp`, `address:estate:offer`, `address:contact:address`
`required`	Yes/No
`scale_label_left`	Text (max. 255)
`scale_label_right`	Text (max. 255)
`searchcriteria_bis_label`	Text (max. 25)
`searchcriteria_list_advisor_mode`	One of: `address`, `fixed`
`searchcriteria_list_advisor_user_id`	Text (max. 30)
`searchcriteria_list_allow_create`	Yes/No
`searchcriteria_list_allow_deactivate`	Yes/No
`searchcriteria_list_allow_deactivate_all`	Yes/No
`searchcriteria_list_allow_duplicate`	Yes/No
`searchcriteria_list_allow_edit`	Yes/No
`searchcriteria_list_allow_reactivate`	Yes/No
`searchcriteria_list_auto_open_create`	Yes/No
`searchcriteria_list_create_limit`	Number
`searchcriteria_list_currency_unit`	Text (max. 10)
`searchcriteria_list_expert_filter`	Text (max. 500)
`searchcriteria_list_show_only_active`	Yes/No
`searchcriteria_list_subform_elements`	List (JSON array)
↳ `allow_input`	Yes/No
↳ `default`	Text (max. 65535)
↳ `default_bis`	Number
↳ `default_von`	Number
↳ `half`	Yes/No
↳ `max`	Number
↳ `min`	Number
↳ `name`	Text (max. 100)
↳ `required`	Yes/No
↳ `step`	Number
↳ `text`	Text (max. 65535)
↳ `type`	One of: `field`, `headline`, `description`, `dividingline`
↳ `variant`	Text (max. 30)
`searchcriteria_von_label`	Text (max. 25)
`select_labels`	Text (max. 65535)
`select_option_meta`	Text (max. 65535)
`signature_field`	Yes/No
`singleselect_enable_typing`	Yes/No
`slider_allow_input`	Yes/No
`special_field`	Text (max. 50)
`step`	Number
`tooltip`	Text (max. 65535)
`upload_field_allow_upload_when_empty`	Yes/No
`upload_field_allowed_extensions`	List (JSON array)
`upload_field_apply_watermark`	Yes/No
`upload_field_deactivate_mail_attachment`	Yes/No
`upload_field_estate_filetype`	Text (max. 50)
`upload_field_estate_set_default_publication_right`	Yes/No
`upload_field_extend_document_attribute`	Yes/No
`upload_field_filled_allow_change`	Yes/No
`upload_field_filled_allow_extend`	Yes/No
`upload_field_filled_enable_download`	Yes/No
`upload_field_freetext`	Text (max. 1000)
`upload_field_merge_files`	Text (max. 50)
`upload_field_merge_zip_only_multiple_files`	Yes/No
`upload_field_merge_zip_rename_files`	Text (max. 1000)
`upload_field_name`	Text (max. 1000)
`upload_field_position`	Number
`upload_field_title`	Text (max. 1000)
`upload_field_write_agentslog`	Yes/No
`upload_field_write_agentslog_aktionsart`	Text
`upload_field_write_agentslog_aktionstyp`	Text
`upload_field_write_agentslog_merkmal`	Text
`upload_field_write_agentslog_with_files`	Yes/No
`variant_axis_labels`	Text (max. 65535)
`variant_centered`	Yes/No
`variant_columns`	Number
`variant_icon_color`	Text (max. 20)
`variant_image_fit`	Text (max. 10)
`variant_image_ratio`	Text (max. 10)
`variant_tile_size`	Text (max. 20)
`video_platform`	Text (max. 50)
`video_slug`	Text (max. 255)
`video_vimeo_hash_parameter`	Text (max. 50)
`yesno_icons`	Yes/No
`yesno_no_icon`	Text (max. 100)
`yesno_no_label`	Text (max. 100)
`yesno_yes_icon`	Text (max. 100)
`yesno_yes_label`	Text (max. 100)