Field Defaults

You can add fields to a template with Add fields to a template, and change them with Update a template’s fields. Every property is optional: a field without a page goes on page 1, and the field’s other properties have the following default values:

Default field values

{
  "hidden": false,
  "x": 0,
  "y": 0,
  "width": 300,
  "height": 55,
  "rotation": 0,
  "display_type": "text",
  "opacity": 1,
  "typeface": null,
  "font_size": null,
  "character_spacing": 0,
  "bold": false,
  "uppercase": false,
  "strikethrough": false,
  "keep_leading_spaces": false,
  "overflow": "shrink_to_fit",
  "multiline": false,
  "multiline_lines": null,
  "min_length": 0,
  "max_length": null,
  "auto_calculate_max_length": false,
  "color": null,
  "color_field_name": null,
  "color_field_required": false,
  "background_color": null,
  "background_color_field_name": null,
  "background_color_field_required": false,
  "alignment": "left",
  "v_alignment": "bottom",
  "comb": false,
  "comb_number_of_cells": 2,
  "comb_value_offset": 0,
  "date_time_format": null,
  "shape_type": "square",
  "shape_sides": 6,
  "shape_fill_color": null,
  "shape_fill_color_field_name": null,
  "shape_fill_color_field_required": false,
  "shape_border_color": "4A90E2",
  "shape_border_color_field_name": null,
  "shape_border_color_field_required": false,
  "shape_border_width": 2,
  "condition": null,
  "string_condition_type": "equals",
  "number_condition_type": "equals",
  "number_condition_range_min": null,
  "number_condition_range_max": null,
  "number_condition_range_exclusive_min": false,
  "number_condition_range_exclusive_max": false,
  "currency": false,
  "decimal_places": null,
  "true_text": null,
  "false_text": null,
  "invert_boolean_condition": false,
  "check_character": "✔",
  "check_color": null,
  "check_color_field_name": null,
  "check_color_field_required": false,
  "qrcode_color": null,
  "qrcode_color_field_name": null,
  "qrcode_color_field_required": false,
  "image_scale_type": "fit",
  "image_gravity": "Center"
}

Properties that are shared by every field with the same name (such as type, required, and default) use the following default values. Note that new fields are required by default ("required": true).

Default shared field values

{
  "type": "string",
  "static": false,
  "editable": false,
  "default": null,
  "title": "",
  "description": "",
  "placeholder": "",
  "metadata": "",
  "required": true,
  "option_list": null,
  "dependencies": null,
  "combined_field_names": "",
  "combined_field_type": "separator",
  "combined_field_separator": " ",
  "combined_field_format": "",
  "integer": false,
  "minimum": null,
  "maximum": null,
  "exclusive_minimum": false,
  "exclusive_maximum": false,
  "include_time": null,
  "signature_allow_draw": true,
  "signature_allow_type": true,
  "barcode_symbology": "code_128"
}

API v1 names these settings in camelCase (fontSize instead of font_size).

Field SchemaSee the data types and enum values for each field property