Référence des champs de l'API

Cette page répertorie tous les champs que vous pouvez écrire (et lire) via l'API propform : le type de données ou le format attendu est indiqué pour chacun d’entre eux. La liste est générée directement à partir des règles de validation de propform et est donc toujours à jour.

> Vous pouvez consulter à tout moment la valeur actuelle d’un champ via GET /forms/{id} ou GET /fields/{id}. Cette page complète ces informations en indiquant le format de saisie, qu’un simple appel de lecture ne révèle pas.

Formats de données et particularités

Certains formats ne sont pas intuitifs – voici les principaux pièges à éviter :

Les champs Oui/Non doivent être acceptés sous la forme true/false (recommandé) ou 1/0.
Les couleurs sont des valeurs hexadécimales avec le signe dièse, par exemple #0d6efd.
datalist (valeurs de sélection d’un champ) doit être indiqué sous forme de liste séparée par des points-virgules : Rot;Grün;Blau.
Les champs de liste (tableau JSON) tels que webhook_modules doivent être fournis sous la forme d’un véritable tableau JSON, par exemple ["address","estate"].
Les mots de passe (par exemple form_password, create_file_owner_password) sont en écriture seule : vous pouvez les définir, mais ils n’apparaissent jamais dans les réponses.
custom_slug doit être unique au sein de votre compte – sinon, utilisez 422.
Avec la commande PATCH, tous les champs sont facultatifs : seules les données que tu envoies sont modifiées. En revanche, un champ envoyé vide sera activement vidé.
Non modifiables (et donc non répertoriés ici) : id, slug, user_id, les indicateurs de modèle et les compteurs.

Pour les propriétés de champ liées à onOffice (onoffice_field_name), vous trouverez les valeurs valides via GET /onoffice/fields.

Paramètres du formulaire

`Champ`	Type / format
`accent_color`	Texte (max. 7)
`access_password`	Texte (max. 255)
`access_password_enabled`	Oui/Non
`access_password_error`	Texte (max. 500)
`access_password_label`	Texte (max. 255)
`active`	Oui/Non
`address_duplicate_check`	Oui/Non
`address_duplicate_check_fields`	Texte (max. 1000)
`address_filter`	Texte (max. 50)
`agentslog_Absagegrund`	Texte (max. 255)
`agentslog_Aktionsart`	Texte (max. 255)
`agentslog_Aktionstyp`	Texte (max. 255)
`agentslog_Bemerkung`	Texte (max. 20000)
`agentslog_Benutzer_nr`	Texte (max. 255)
`agentslog_Beratungsebene`	Texte (max. 1)
`agentslog_Dauer`	Nombre
`agentslog_HerkunftKontakt`	Texte (max. 255)
`agentslog_Kosten`	Nombre
`agentslog_merkmal`	Texte (max. 255)
`ai_voice_fill_active`	Oui/Non
`auto_send_form`	Oui/Non
`background_color`	Texte (max. 7)
`background_image_blur`	Nombre
`background_image_brightness`	Nombre
`background_image_contrast`	Nombre
`background_image_greyscale`	Nombre
`background_image_url`	URL
`card_background_blur`	Nombre
`card_background_color`	Texte (max. 7)
`card_background_opacity`	Nombre
`card_corners`	Texte (max. 20)
`card_font_color`	Texte (max. 7)
`card_shadow`	Texte (max. 255)
`create_file`	Oui/Non
`create_file_certificate_contact_info`	Texte (max. 128)
`create_file_certificate_encryption`	Une de: `none`, `default`, `user`
`create_file_certificate_encryption_permissions`	Liste (tableau JSON)
`create_file_certificate_location`	Texte (max. 128)
`create_file_certificate_name`	Texte (max. 64)
`create_file_certificate_reason`	Texte (max. 128)
`create_file_certificate_type`	Une de: `none`, `default`, `user`
`create_file_certification_level`	Une de: `0`, `1`, `2`
`create_file_destination`	Texte (max. 16000)
`create_file_destination_field`	Texte (max. 50)
`create_file_documentattribute`	Texte (max. 50)
`create_file_name`	Texte (max. 100)
`create_file_owner_password`	Texte (max. 200)
`create_file_pdf_exposes`	Oui/Non
`create_file_pdfexposeidentifiers`	Texte (max. 16000)
`create_file_permissions`	Liste (tableau JSON)
`create_file_sign_pdf`	Oui/Non
`create_file_user_password`	Texte (max. 200)
`custom_slug`	Texte (unique par compte)
`default_imprint`	Oui/Non
`default_styling`	Oui/Non
`description`	Texte (max. 65535)
`disable_submit_button`	Oui/Non
`enable_onoffice_prefill`	Oui/Non
`enable_prefill_with_UUIDs`	Oui/Non
`estate_duplicate_check_objektnr_extern`	Oui/Non
`estate_duplicate_check_objektnr_extern_exists`	Oui/Non
`estate_filter`	Texte (max. 50)
`etracker_active`	Oui/Non
`etracker_id`	Texte (max. 15)
`execute_webhooks`	Oui/Non
`expiration_date_required`	Oui/Non
`expiration_date_required_encrypted`	Oui/Non
`facebook_pixel_active`	Oui/Non
`facebook_pixel_id`	Texte (max. 25)
`favicon_url`	URL
`font_color_submit`	Texte (max. 7)
`form_groups`	Liste d’ID de groupes
`form_password`	Texte (max. 255)
`form_password_error`	Texte (max. 500)
`form_width`	Nombre
`google_font_name`	Texte (max. 255)
`google_tag_manager_active`	Oui/Non
`google_tag_manager_id`	Texte (max. 15)
`headline_font`	Texte (max. 255)
`headline_font_color`	Texte (max. 7)
`headline_font_size`	Nombre
`homepage_url`	URL
`iframe_options`	Liste (tableau JSON)
`iframe_script_version`	Texte (max. 50)
`imprint_line_1`	Texte (max. 255)
`imprint_line_2`	Texte (max. 255)
`imprint_line_3`	Texte (max. 255)
`imprint_line_4`	Texte (max. 255)
`imprint_line_5`	Texte (max. 255)
`imprint_url`	URL
`internal_note`	Texte (max. 65535)
`internal_title`	Texte
`ip_whitelist`	Oui/Non
`ip_whitelist_ips`	Texte (max. 2000)
`load_related_address_dataset`	Texte
`load_related_estate_dataset`	Texte
`load_related_estate_dataset_kontaktart`	Texte (max. 50)
`loaded_datasets_required`	Oui/Non
`loaded_datasets_required_address`	Oui/Non
`loaded_datasets_required_estate`	Oui/Non
`logo_url`	URL
`multistep_active`	Oui/Non
`multistep_back_label`	Texte (max. 100)
`multistep_continue_label`	Texte (max. 100)
`multistep_show_back_button`	Oui/Non
`multistep_show_progress`	Oui/Non
`password_required`	Oui/Non
`pre_agentslog_Absagegrund`	Texte (max. 255)
`pre_agentslog_Aktionsart`	Texte (max. 255)
`pre_agentslog_Aktionstyp`	Texte (max. 255)
`pre_agentslog_Bemerkung`	Texte (max. 20000)
`pre_agentslog_Benutzer_nr`	Texte (max. 255)
`pre_agentslog_Beratungsebene`	Texte (max. 1)
`pre_agentslog_Dauer`	Nombre
`pre_agentslog_HerkunftKontakt`	Texte (max. 255)
`pre_agentslog_Kosten`	Nombre
`pre_agentslog_merkmal`	Texte (max. 255)
`pre_write_agentslog`	Oui/Non
`privacypolicy_url`	URL
`redirect`	Texte (max. 65535)
`redirect_append_address_uuid`	Oui/Non
`redirect_append_address_uuid_type`	Texte (max. 50)
`redirect_append_address_uuid_type_kontaktart`	Texte (max. 50)
`redirect_append_estate_uuid`	Oui/Non
`redirect_append_estate_uuid_type`	Texte (max. 50)
`relation_estate`	Texte (max. 100)
`selling_price_offer_address_field`	Texte (max. 50)
`send_submission_mail`	Oui/Non
`staff_allowed_group_ids`	Liste (tableau JSON)
`staff_allowed_member_ids`	Liste (tableau JSON)
`staff_only_enabled`	Oui/Non
`submission_mail_address`	E-mail
`submit_button_label`	Texte (max. 255)
`submit_open`	Texte (max. 10)
`submit_spinner_label`	Texte (max. 255)
`task_Art`	Texte (max. 255)
`task_Aufgabe`	Texte (max. 10000)
`task_Bearbeiter`	Texte (max. 255)
`task_Betreff`	Texte (max. 255)
`task_Prio`	Texte (max. 255)
`task_Status`	Texte (max. 255)
`task_Verantwortung`	Texte (max. 255)
`thankyou_headline`	Texte (max. 200)
`thankyou_rules`	Liste (tableau JSON)
`thankyou_rules_active`	Oui/Non
`thankyou_text`	Texte (max. 5000)
`title`	Texte (max. 255)
`webhook_modules`	Liste (tableau JSON)
`write_agentslog`	Oui/Non
`write_agentslog_with_files`	Oui/Non
`write_multiselect_values`	Liste (tableau JSON)
`write_selling_price_offer_to_field`	Oui/Non
`write_task`	Oui/Non
`write_task_with_files`	Oui/Non
`write_values`	Oui/Non
`write_values_in_address_or_estate`	JSON

Paramètres e-mail (e-mail de confirmation)

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

Paramètres ChatGPT

`Champ`	Type / format
`chat_gpt_active`	Oui/Non
`chat_gpt_assistant_content`	Texte (max. 65000)
`chat_gpt_frequency_penalty`	Nombre
`chat_gpt_max_tokens`	Nombre
`chat_gpt_model`	Texte (max. 50)
`chat_gpt_n`	Nombre
`chat_gpt_onoffice_fieldname`	Texte (max. 50)
`chat_gpt_onoffice_module`	Texte (max. 50)
`chat_gpt_presence_penalty`	Nombre
`chat_gpt_stop`	Texte (max. 100)
`chat_gpt_system_content`	Texte (max. 65000)
`chat_gpt_temperature`	Nombre
`chat_gpt_top_p`	Nombre
`chat_gpt_user_content`	Texte (max. 65000)
`chat_gpt_user_content2`	Texte (max. 65000)

Propriétés du champ

`Champ`	Type / format
`address_live_search`	Oui/Non
`address_live_search_prefill`	Oui/Non
`address_related_suggestions`	Liste (tableau JSON)
`autocomplete`	Texte (max. 50)
`break_gtm_step_name`	Texte (max. 50)
`collapsible_section_status`	Texte (max. 50)
`datalist`	Texte (max. 65535)
`default_value`	Texte (max. 65535)
`disabled`	Oui/Non
`documentAttribute`	Texte (max. 255)
`download_field_create_file_pdfexposeidentifier`	Texte (max. 100)
`download_field_create_file_type`	Texte (max. 50)
`download_field_document_attribute_contains`	Texte (max. 100)
`download_field_estate_document_attribute`	Texte (max. 100)
`download_field_estate_file_title_contains`	Texte (max. 100)
`download_field_estate_file_type`	Texte (max. 50)
`download_field_file_name_contains`	Texte (max. 100)
`download_field_file_name_downloaded_file`	Texte (max. 1000)
`download_field_hide_when_empty`	Oui/Non
`download_field_selector`	Texte (max. 50)
`download_field_url`	Texte (max. 1000)
`download_field_write_agentslog`	Oui/Non
`download_field_write_agentslog_aktionsart`	Texte
`download_field_write_agentslog_aktionstyp`	Texte
`download_field_write_agentslog_merkmal`	Texte
`download_field_write_agentslog_with_files`	Oui/Non
`enable_prefill_with_url_parameters`	Oui/Non
`estate_live_search`	Oui/Non
`estate_live_search_prefill`	Oui/Non
`estate_related_suggestions`	Liste (tableau JSON)
`force_value`	Texte (max. 65535)
`half_size`	Oui/Non
`hidden`	Oui/Non
`hint`	Texte (max. 65535)
`iframe_height`	Texte (max. 10)
`iframe_height_auto`	Oui/Non
`iframe_parameters`	Liste (tableau JSON)
`iframe_submit_open`	Texte (max. 10)
`iframe_url`	Texte (max. 65535)
`image_url`	Texte (max. 65535)
`label`	Texte (max. 65535)
`limit_value`	Texte (max. 65535)
`link_append_address_uuid`	Oui/Non
`link_append_address_uuid_type`	Texte (max. 50)
`link_append_address_uuid_type_kontaktart`	Texte (max. 50)
`link_append_estate_uuid`	Oui/Non
`link_append_estate_uuid_type`	Texte (max. 50)
`link_button_link`	Texte (max. 65535)
`link_open_in_new_tab`	Oui/Non
`max_value`	Nombre
`min_value`	Nombre
`min_value_onoffice`	Oui/Non
`multiselect_close_on_selection`	Oui/Non
`multiselect_mode`	Texte (max. 50)
`multiselect_open_on_typing`	Oui/Non
`number_stepper`	Oui/Non
`number_stepper_step`	Nombre
`number_unit`	Texte (max. 25)
`onoffice_field_name`	Texte
`onoffice_module`	Texte
`placeholder`	Texte (max. 65535)
`read_only`	Oui/Non
`required`	Oui/Non
`searchcriteria_bis_label`	Texte (max. 25)
`searchcriteria_von_label`	Texte (max. 25)
`select_labels`	Texte (max. 65535)
`signature_field`	Oui/Non
`singleselect_enable_typing`	Oui/Non
`special_field`	Texte (max. 50)
`step`	Nombre
`tooltip`	Texte (max. 65535)
`upload_field_allow_upload_when_empty`	Oui/Non
`upload_field_allowed_extensions`	Liste (tableau JSON)
`upload_field_apply_watermark`	Oui/Non
`upload_field_deactivate_mail_attachment`	Oui/Non
`upload_field_estate_filetype`	Texte (max. 50)
`upload_field_estate_set_default_publication_right`	Oui/Non
`upload_field_extend_document_attribute`	Oui/Non
`upload_field_filled_allow_change`	Oui/Non
`upload_field_filled_allow_extend`	Oui/Non
`upload_field_filled_enable_download`	Oui/Non
`upload_field_freetext`	Texte (max. 1000)
`upload_field_merge_files`	Texte (max. 50)
`upload_field_merge_zip_only_multiple_files`	Oui/Non
`upload_field_merge_zip_rename_files`	Texte (max. 1000)
`upload_field_name`	Texte (max. 1000)
`upload_field_position`	Nombre
`upload_field_title`	Texte (max. 1000)
`upload_field_write_agentslog`	Oui/Non
`upload_field_write_agentslog_aktionsart`	Texte
`upload_field_write_agentslog_aktionstyp`	Texte
`upload_field_write_agentslog_merkmal`	Texte
`upload_field_write_agentslog_with_files`	Oui/Non
`video_platform`	Texte (max. 50)
`video_slug`	Texte (max. 255)
`video_vimeo_hash_parameter`	Texte (max. 50)