Skip to content

Field Defaults

You can manually add a new field to a template by sending an Add Field API request. You can also modify existing fields or add many new fields at once with an Update Template request.

When adding fields to a template, the only required property is name. page is also required for PDF templates but not for HTML templates.

All other field properties will be set to the following default values:

Default field values
{
"id": 0,
"name": "",
"hidden": false,
"acroform_name": "",
"x": 0,
"y": 0,
"width": 300,
"height": 55,
"rotation": 0,
"displayType": "text",
"opacity": 1,
"typeface": null,
"fontSize": null,
"characterSpacing": 0,
"bold": false,
"uppercase": false,
"strikethrough": false,
"overflow": "shrink_to_fit",
"multiline": false,
"multilineLines": null,
"minLength": 0,
"maxLength": null,
"autoCalculateMaxLength": false,
"color": null,
"colorFieldName": null,
"colorFieldRequired": false,
"backgroundColor": null,
"backgroundColorFieldName": null,
"backgroundColorFieldRequired": false,
"alignment": "left",
"vAlignment": "bottom",
"comb": false,
"combNumberOfCells": 2,
"combValueOffset": 0,
"dateTimeFormat": null,
"shapeType": "square",
"shapeFillColor": null,
"shapeFillColorFieldName": null,
"shapeFillColorFieldRequired": false,
"shapeBorderColor": "4A90E2",
"shapeBorderColorFieldName": null,
"shapeBorderColorFieldRequired": false,
"shapeBorderWidth": 2,
"condition": null,
"stringConditionType": "equals",
"numberConditionType": "equals",
"numberConditionRangeMin": null,
"numberConditionRangeMax": null,
"numberConditionRangeExclusiveMin": false,
"numberConditionRangeExclusiveMax": false,
"currency": false,
"decimalPlaces": null,
"trueText": null,
"falseText": null,
"invertBooleanCondition": false,
"checkCharacter": "✔",
"checkColor": null,
"checkColorFieldName": null,
"checkColorFieldRequired": false,
"qrcodeColor": null,
"qrcodeColorFieldName": null,
"qrcodeColorFieldRequired": false,
"imageScaleType": "fit",
"imageGravity": "Center"
}