Text Field API

This document contains the Text field API format and a list of supported attributes.

Use this page to add a text field to template XML. Assign the field to a role with roleId, then reuse the same field name in envelope requests.

Text field example

<field
    type="text"
    name="customer_name"
    placeholder="Enter customer name"
    roleId="fd8cb669-db1d-41e1-8f6c-2ad3f8fa981a"
    optional="false"
    search="true"
    multilines="false"
    min="1"
    max="128"
/>

How it works

1. Add the field inside the document body.

2. Assign the field to a recipient role with roleId.

3. Reuse the same field name later when sending or filling an envelope.

Required attributes

• type — field type. Use text.

• name — field name. Use 1 to 128 characters. Do not use &, ", <, or >. Keep the value unique within one document.

• roleId — role identifier for the recipient who fills the field.

Keep name unique within one document. Reuse the same name later in envelope data.

Optional attributes

• placeholder — placeholder text shown in the template and envelope. Use 0 to 1024 characters. If you omit it, the envelope shows the field name.

• optional — set to true if the recipient can leave the field empty. If you omit it, the default value is false.

• search — set to true if the field value should be available in envelope search. If you omit it, the default value is false.

• multilines — set to true for a multiline text field. Set to false for a single-line text field. If you omit it, the default value is false.

• min — minimum number of characters allowed in the field value.

• max — maximum number of characters allowed in the field value.

Validation rules

• min and max define character count, not word count.

• Single-line text fields support 0 to 1000.

• Multiline text fields support 0 to 5000.

• min and max are optional.

Related topics

• Template Dynamic Fields API

• Template Structure API

• Send Envelope

• Fill Envelope