Riferimento ai campi dell'API

Questa pagina elenca tutti i campi che puoi scrivere (e leggere) tramite l'API propform nei moduli, nella configurazione e-mail/ChatGPT e nei campi – indicando per ciascuno il tipo di dati o il formato previsto. L’elenco viene generato direttamente dalle regole di convalida di propform ed è quindi sempre aggiornato.

> Puoi visualizzare in qualsiasi momento il valore attuale di un campo tramite GET /forms/{id} o GET /fields/{id}. Questa pagina integra tali informazioni con il formato di immissione, che una semplice chiamata di lettura non rivela.

Formati dei dati e particolarità

Alcuni formati non sono intuitivi: ecco le insidie più importanti:

I campi Sì/No vanno accettati come true/false (consigliato) oppure 1/0.
I colori sono valori esadecimali con il simbolo #, ad es. #0d6efd.
datalist (valori di selezione di un campo) va specificato come elenco separato da punti e virgola: Rot;Grün;Blau.
I campi elenco (array JSON) come webhook_modules devono essere specificati come un vero e proprio array JSON, ad es. ["address","estate"].
Le password (ad es. form_password, create_file_owner_password) sono di sola scrittura: puoi impostarle, ma non compaiono mai nelle risposte.
custom_slug deve essere univoco all’interno del tuo account; in caso contrario, usa 422.
Nel PATCH tutti i campi sono facoltativi: vengono modificati solo i dati che invii. Un campo inviato vuoto, invece, viene svuotato automaticamente.
Non scrivibili (e quindi non elencati qui): id, slug, user_id, flag dei modelli e contatori.
Elenchi di elementi dei miniform (relation_subform_elements nel campo di collegamento, searchcriteria_list_subform_elements nel widget dei profili di ricerca) sono array JSON di oggetti; le chiavi consentite per voce sono elencate come righe ↳ subito sotto il campo elenco. type è field (con name = nome del campo onOffice) oppure un elemento di layout (headline, description, dividingline, nel campo di collegamento anche collapsible, ciascuno con text). Nel widget dei profili di ricerca, default, default_von e default_bis valgono solo per i nuovi profili (campi multipli come elenco separato da punto e virgola, sì/no come "1"/"0", tutti i valori come testo); min, max, step e allow_input appartengono alla visualizzazione slider.

Per le proprietà dei campi relative a onOffice (onoffice_field_name), i valori validi sono riportati in GET /onoffice/fields.

Impostazioni del modulo

`Campo`	Tipo / formato
`accent_color`	Testo (max. 7)
`access_password`	Testo (max. 255)
`access_password_enabled`	Sì/No
`access_password_error`	Testo (max. 500)
`access_password_label`	Testo (max. 255)
`active`	Sì/No
`address_duplicate_check`	Sì/No
`address_duplicate_check_fields`	Testo (max. 1000)
`address_filter`	Testo (max. 50)
`agentslog_Absagegrund`	Testo (max. 255)
`agentslog_Aktionsart`	Testo (max. 255)
`agentslog_Aktionstyp`	Testo (max. 255)
`agentslog_Bemerkung`	Testo (max. 20000)
`agentslog_Benutzer_nr`	Testo (max. 255)
`agentslog_Beratungsebene`	Testo (max. 1)
`agentslog_Dauer`	Numero
`agentslog_HerkunftKontakt`	Testo (max. 255)
`agentslog_Kosten`	Numero
`agentslog_merkmal`	Testo (max. 255)
`ai_voice_fill_active`	Sì/No
`auto_send_form`	Sì/No
`background_color`	Testo (max. 7)
`background_image_blur`	Numero
`background_image_brightness`	Numero
`background_image_contrast`	Numero
`background_image_greyscale`	Numero
`background_image_url`	URL
`card_background_blur`	Numero
`card_background_color`	Testo (max. 7)
`card_background_opacity`	Numero
`card_corners`	Testo (max. 20)
`card_font_color`	Testo (max. 7)
`card_shadow`	Testo (max. 255)
`create_file`	Sì/No
`create_file_certificate_contact_info`	Testo (max. 128)
`create_file_certificate_encryption`	Uno di: `none`, `default`, `user`
`create_file_certificate_encryption_permissions`	Elenco (array JSON)
`create_file_certificate_location`	Testo (max. 128)
`create_file_certificate_name`	Testo (max. 64)
`create_file_certificate_reason`	Testo (max. 128)
`create_file_certificate_type`	Uno di: `none`, `default`, `user`
`create_file_certification_level`	Uno di: `0`, `1`, `2`
`create_file_destination`	Uno di: `FormAddress`, `FormEstate`
`create_file_destination_field`	Testo (max. 50)
`create_file_documentattribute`	Testo (max. 50)
`create_file_name`	Testo (max. 100)
`create_file_owner_password`	Testo (max. 200)
`create_file_pdf_exposes`	Sì/No
`create_file_pdfexposeidentifiers`	Testo (max. 16000)
`create_file_permissions`	Elenco (array JSON)
`create_file_sign_pdf`	Sì/No
`create_file_user_password`	Testo (max. 200)
`custom_slug`	Testo (unico per account)
`default_imprint`	Sì/No
`default_styling`	Sì/No
`description`	Testo (max. 65535)
`disable_submit_button`	Sì/No
`enable_onoffice_prefill`	Sì/No
`enable_prefill_with_UUIDs`	Sì/No
`estate_duplicate_check_objektnr_extern`	Sì/No
`estate_duplicate_check_objektnr_extern_exists`	Sì/No
`estate_filter`	Testo (max. 50)
`etracker_active`	Sì/No
`etracker_id`	Testo (max. 15)
`execute_webhooks`	Sì/No
`expiration_date_required`	Sì/No
`expiration_date_required_encrypted`	Sì/No
`facebook_pixel_active`	Sì/No
`facebook_pixel_id`	Testo (max. 25)
`favicon_url`	URL
`font_color_submit`	Testo (max. 7)
`form_groups`	Elenco di ID gruppo
`form_password`	Testo (max. 255)
`form_password_error`	Testo (max. 500)
`form_template`	Sì/No
`form_width`	Numero
`google_font_name`	Uno di: `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`	Sì/No
`google_tag_manager_id`	Testo (max. 15)
`headline_font`	Uno di: `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`	Testo (max. 7)
`headline_font_size`	Numero
`homepage_url`	URL
`iframe_options`	Elenco (array JSON)
`iframe_script_version`	Testo (max. 50)
`imprint_line_1`	Testo (max. 255)
`imprint_line_2`	Testo (max. 255)
`imprint_line_3`	Testo (max. 255)
`imprint_line_4`	Testo (max. 255)
`imprint_line_5`	Testo (max. 255)
`imprint_url`	URL
`internal_note`	Testo (max. 65535)
`internal_title`	Testo
`ip_whitelist`	Sì/No
`ip_whitelist_ips`	Testo (max. 2000)
`load_related_address_dataset`	Uno di: `none`, `OwnerEstate`, `SecondOwnerEstate`, `ThirdOwnerEstate`, `BuyerEstate`, `SecondBuyerEstate`, `ThirdBuyerEstate`, `RenterEstate`, `SecondRenterEstate`, `ThirdRenterEstate`, `TippEstate`, `ContactPersonBroker`, `ContactPerson`, `SecondContactPerson`, `ThirdContactPerson`, `SupervisorEstate`
`load_related_address_dataset_kontaktart`	Testo (max. 50)
`load_related_estate_dataset`	Uno di: `none`, `OwnedEstate`, `SecondOwnedEstate`, `ThirdOwnedEstate`, `BoughtEstate`, `SecondBoughtEstate`, `ThirdBoughtEstate`, `RentedEstate`, `SecondRentedEstate`, `ThirdRentedEstate`, `TippedEstate`, `SecondTippedEstate`, `ThirdTippedEstate`
`loaded_datasets_required`	Sì/No
`loaded_datasets_required_address`	Sì/No
`loaded_datasets_required_estate`	Sì/No
`logo_url`	URL
`multistep_active`	Sì/No
`multistep_back_label`	Testo (max. 100)
`multistep_continue_label`	Testo (max. 100)
`multistep_show_back_button`	Sì/No
`multistep_show_progress`	Sì/No
`password_required`	Sì/No
`pre_agentslog_Absagegrund`	Testo (max. 255)
`pre_agentslog_Aktionsart`	Testo (max. 255)
`pre_agentslog_Aktionstyp`	Testo (max. 255)
`pre_agentslog_Bemerkung`	Testo (max. 20000)
`pre_agentslog_Benutzer_nr`	Testo (max. 255)
`pre_agentslog_Beratungsebene`	Testo (max. 1)
`pre_agentslog_Dauer`	Numero
`pre_agentslog_HerkunftKontakt`	Testo (max. 255)
`pre_agentslog_Kosten`	Numero
`pre_agentslog_merkmal`	Testo (max. 255)
`pre_write_agentslog`	Sì/No
`privacypolicy_url`	URL
`redirect`	Testo (max. 65535)
`redirect_append_address_uuid`	Sì/No
`redirect_append_address_uuid_type`	Uno di: `FormAddress`, `OwnerEstate`, `SecondOwnerEstate`, `ThirdOwnerEstate`, `BuyerEstate`, `SecondBuyerEstate`, `ThirdBuyerEstate`, `RenterEstate`, `SecondRenterEstate`, `ThirdRenterEstate`, `TippEstate`, `ContactPersonBroker`, `ContactPerson`, `SecondContactPerson`, `ThirdContactPerson`, `SupervisorEstate`, `SupervisorAddress`
`redirect_append_address_uuid_type_kontaktart`	Testo (max. 50)
`redirect_append_estate_uuid`	Sì/No
`redirect_append_estate_uuid_type`	Uno di: `FormEstate`, `OwnedEstate`, `SecondOwnedEstate`, `ThirdOwnedEstate`, `BoughtEstate`, `SecondBoughtEstate`, `ThirdBoughtEstate`, `RentedEstate`, `SecondRentedEstate`, `ThirdRentedEstate`, `TippedEstate`, `SecondTippedEstate`, `ThirdTippedEstate`
`relation_estate`	Testo (max. 100)
`selling_price_offer_address_field`	Testo (max. 50)
`send_submission_mail`	Sì/No
`staff_allowed_group_ids`	Elenco (array JSON)
`staff_allowed_member_ids`	Elenco (array JSON)
`staff_only_enabled`	Sì/No
`submission_mail_address`	Email
`submit_button_label`	Testo (max. 255)
`submit_open`	Testo (max. 10)
`submit_spinner_label`	Testo (max. 255)
`task_Art`	Testo (max. 255)
`task_Aufgabe`	Testo (max. 10000)
`task_Bearbeiter`	Testo (max. 255)
`task_Betreff`	Testo (max. 255)
`task_Prio`	Testo (max. 255)
`task_Status`	Testo (max. 255)
`task_Verantwortung`	Testo (max. 255)
`thankyou_headline`	Testo (max. 200)
`thankyou_rules`	Elenco (array JSON)
`thankyou_rules_active`	Sì/No
`thankyou_text`	Testo (max. 5000)
`title`	Testo (max. 255)
`webhook_modules`	Elenco (array JSON)
`write_agentslog`	Sì/No
`write_agentslog_with_files`	Sì/No
`write_multiselect_values`	Elenco (array JSON)
`write_selling_price_offer_to_field`	Sì/No
`write_task`	Sì/No
`write_task_with_files`	Sì/No
`write_values`	Sì/No
`write_values_in_address_or_estate`	JSON

Impostazioni email (email di conferma)

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

Impostazioni ChatGPT

`Campo`	Tipo / formato
`chat_gpt_active`	Sì/No
`chat_gpt_assistant_content`	Testo (max. 65000)
`chat_gpt_frequency_penalty`	Numero
`chat_gpt_max_tokens`	Numero
`chat_gpt_model`	Testo (max. 50)
`chat_gpt_n`	Numero
`chat_gpt_onoffice_fieldname`	Testo (max. 50)
`chat_gpt_onoffice_module`	Testo (max. 50)
`chat_gpt_presence_penalty`	Numero
`chat_gpt_stop`	Testo (max. 100)
`chat_gpt_system_content`	Testo (max. 65000)
`chat_gpt_temperature`	Numero
`chat_gpt_top_p`	Numero
`chat_gpt_user_content`	Testo (max. 65000)
`chat_gpt_user_content2`	Testo (max. 65000)

Proprietà del campo

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