Tag options

Overview

Template tags can be customized using various options to control their behavior and appearance. These options are specified within the tag syntax and can include properties such as size, alignment, position, validation, default values, and more.

Options syntax

Options are specified within the template tag using key-value pairs separated by underscores.

There are two syntaxes for specifying options, some options use the option_<key>_<value> syntax, while others use the <key>_<value> syntax.

`option_<key>_<value>`

long

{{signer_<signer_number>:<tag>_<tag_id>:option_<key>_<value>}}

`<key>_<value>`

long

{{s_<signer_number>:<tag>_<tag_id>:<key>_<value>}}

PDF units

Many tag options use PDF units for measurements. In PDF units, 1 inch is equal to 72 units. A standard letter-size document (8.5 x 11 inches) is therefore 612 x 792 PDF units.

Options

Optional

The optional option allows you to specify whether a tag field is optional or required.

long

{{signer_1:text_1:option_optional}}

short

{{s_1:text_1:o_opt}}

Width

The width option allows you to set the width of the tag field in PDF units.

long

{{signer_1:text_1:option_width_200}}

short

{{s_1:text_1:o_w_200}}

Height

The height option allows you to set the height of the tag field in PDF units.

long

{{signer_1:text_1:option_height_50}}

short

{{s_1:text_1:o_h_50}}

Align

The align option allows you to align the tag field to the left , center, or right within its designated area.

left
center
right

long

{{signer_1:text_1:option_align_left}}

short

{{s_1:text_1:o_a_l}}

long

{{signer_1:text_1:option_align_center}}

short

{{s_1:text_1:o_a_c}}

long

{{signer_1:text_1:option_align_right}}

short

{{s_1:text_1:o_a_r}}

Size

The size option allows you to set the size of the tag field (width and height) in PDF units

long

{{signer_1:text_1:size_(200,50)}}

short

{{s_1:text_1:sz_(200,50)}}

Offset

The offset option allows you to set the position offset of the tag field in PDF units.

Useful for fine-tuning the placement of the tag field, such as radio or checkbox, within the document.

Positive values move the field right and down, while negative values move it left and up.

long

{{signer_1:text_1:offset_10x-40)}}

short

{{s_1:text_1:f_10x-40)}}

Value

The value option allows you to set a default value for the tag field.

When using default values that contain spaces or special characters, ensure to properly encode them using an URL encoder to avoid parsing issues.

Default value can currently be set for text, multiline, radio, and checkbox tags.

Text tag
Multiline tag
Radio tag
Checkbox tag

long

{{signer_1:text_1:value_DefaultText}}

short

{{s_1:text_1:v_DefaultText}}

long

{{signer_1:multiline_1:value_Default%20multiline%20text.}}

short

{{s_1:multi_1:v_Default%20multiline%20text.}}

Set a default value of radio 1.1 to true (selected).

long

{{signer_1:radio_1}}
{{radio_1.1:value_true}}
{{radio_1.2}}
{{radio_1.3}}

short

{{s_1:r_1}}
{{r_1.1:v_true}}
{{r_1.2}}
{{r_1.3}}

Set a default value of checkbox 1.1 to true (checked).

long

{{signer_1:checkbox_1.1:value_true}}

short

{{s_1:c_1.1:v_true}}

Data ID

The dataid option allows you to assign a custom data identifier to the tag field for easier reference.

long

{{signer_1:text_1:dataid_customID123}}

short

{{s_1:text_1:id_customID123}}

See the Templating data guide for more information.

Getting started

Guides

API

Webhooks

Reference

Overview

Options syntax

`option_<key>_<value>`

`<key>_<value>`

PDF units

Options

Optional

Width

Height

Font size

Align

Size

Offset

Value

Data ID

​Overview

​Options syntax

​option_<key>_<value>

​<key>_<value>

​PDF units

​Options

​Optional

​Width

​Height

​Font size

​Align

​Size

​Offset

​Value

​Data ID

Overview

Options syntax

`option_<key>_<value>`

`<key>_<value>`

PDF units

Options

Optional

Width

Height

Font size

Align

Size

Offset

Value

Data ID