Referencia de campos de la API

Esta página enumera todos los campos que puedes escribir (y leer) en los formularios, en la configuración de correo electrónico/ChatGPT y en los campos mediante la API de propform en los formularios, en la configuración de correo electrónico/ChatGPT y en los campos —en cada caso, con el tipo de datos o formato esperado—. La lista se genera directamente a partir de las reglas de validación de propform, por lo que siempre está actualizada.

> Puedes ver el valor actual de un campo en cualquier momento mediante GET /forms/{id} o GET /fields/{id}. Esta página complementa esa información con el formato de entrada, que una simple llamada de lectura no revela.

Formatos de datos y particularidades

Algunos formatos no son evidentes por sí mismos; a continuación, te indicamos los principales escollos:

  • Los campos Sí/No se aceptan como true/false (recomendado) o 1/0.
  • Los colores son valores hexadecimales que incluyen el símbolo de almohadilla, p. ej., #0d6efd.
  • datalist (valores de selección de un campo) se indican como una lista separada por punto y coma: Rot;Grün;Blau.
  • Los campos de lista (matriz JSON), como webhook_modules, deben proporcionarse como una matriz JSON válida, p. ej., ["address","estate"].
  • Las contraseñas (p. ej., form_password, create_file_owner_password) son de solo escritura: puedes establecerlas, pero nunca aparecerán en las respuestas.
  • custom_slug debe ser único dentro de tu cuenta; de lo contrario, utiliza 422.
  • En el PATCH, todos los campos son opcionales: solo se modifica lo que envíes. Por el contrario, un campo enviado vacío se vaciará de forma activa.
  • No editables (y, por lo tanto, no aparecen en esta lista): id, slug, user_id, indicadores de plantilla y contadores.
  • Listas de elementos de los miniformularios (relation_subform_elements en el campo de relación, searchcriteria_list_subform_elements en el widget de perfiles de búsqueda) son arrays JSON de objetos; las claves permitidas por entrada aparecen como filas ↳ justo debajo del campo de lista. type es field (con name = nombre del campo onOffice) o un elemento de diseño (headline, description, dividingline, en el campo de relación también collapsible, cada uno con text). En el widget de perfiles de búsqueda, default, default_von y default_bis solo se aplican a perfiles nuevos (campos múltiples como lista separada por punto y coma, sí/no como "1"/"0", todos los valores como texto); min, max, step y allow_input pertenecen a la presentación slider.

Para las propiedades de campo relacionadas con onOffice (onoffice_field_name), encontrarás los valores válidos en GET /onoffice/fields.

Ajustes del formulario

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

Ajustes de correo (correo de confirmación)

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 Texto
bcc_2 Texto
bcc_kontaktart Texto
bcc_kontaktart_2 Texto
bcc_switch Texto
bcc_switch_2 Texto
body Texto
body_2 Texto
cc Texto
cc_2 Texto
cc_kontaktart Texto
cc_kontaktart_2 Texto
cc_switch Texto
cc_switch_2 Texto
displayName Texto
displayName_2 Texto
documentattributes Texto
documentattributes_2 Texto
emailidentity Texto (máx. 100)
emailidentity_2 Texto (máx. 100)
macro_resolve Texto
macro_resolve_2 Texto
pdfexposeidentifiers Texto
pdfexposeidentifiers_2 Texto
pdfformids Texto
pdfformids_2 Texto
pdfletterids Texto
pdfletterids_2 Texto
receiver Texto
receiver_2 Texto
receiver_kontaktart Texto
receiver_kontaktart_2 Texto
receiver_switch Texto
receiver_switch_2 Texto
replyto Texto
replyto_2 Texto
send_email_via_onoffice Sí/No
send_email_via_onoffice_2 Sí/No
subject Texto
subject_2 Texto
templateid Texto
templateid_2 Texto
useHtml Sí/No
useHtml_2 Sí/No
webexposeids Texto
webexposeids_2 Texto

Ajustes de ChatGPT

Campo Tipo / formato
chat_gpt_active Sí/No
chat_gpt_assistant_content Texto (máx. 65000)
chat_gpt_frequency_penalty Número
chat_gpt_max_tokens Número
chat_gpt_model Texto (máx. 50)
chat_gpt_n Número
chat_gpt_onoffice_fieldname Texto (máx. 50)
chat_gpt_onoffice_module Texto (máx. 50)
chat_gpt_presence_penalty Número
chat_gpt_stop Texto (máx. 100)
chat_gpt_system_content Texto (máx. 65000)
chat_gpt_temperature Número
chat_gpt_top_p Número
chat_gpt_user_content Texto (máx. 65000)
chat_gpt_user_content2 Texto (máx. 65000)

Propiedades del campo

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