If used, options must be used in a specific order:
| Order | Name | Description |
|---|---|---|
| 1 | Field Type | Valid values: text, signature or s (short version), initial or i, date or d,check or c, autofill_first_name, autofill_last_name, autofill_name, autofill_email, autofill_company, autofill_phone, autofill_title, autofill_date_signed or short version: af_f_n, af_l_n af_n, af_e, af_c, af_p, af_t, af_d_s. |
| 2 | Signer Number | Valid values are integers (1, 2, 3, etc.) and represent the signer in the order that your API request sends them within the recipient param. |
| 3 | Required | y or n to indicate whether the field should be required. |
| 4 | Label | The field label. Only applies to text and date fields. |
| 5 | Prefill Value | A value to prefill the field with. Does not apply to signatures or initials fields. Text and date fields take any value you can type into those fields. Checkboxes can use 1 or 0 to check or uncheck. |
| 6 | API ID | A field identifier given to the field. |
| 7 | Width | By default, the field width will match the width of the Text Tag. You can override that by specifying a pixel value (as an integer). 80 would represent 80px. |
| 8 | Height | By default, the field height will match the height of the Text Tag. You can override that by specifying a pixel value (as an integer). 30 would represent 30px. |
Additional text field options (only for text fields):
| Order | Name | Description |
|---|---|---|
| 9 | Validation Type | Enforces validation of text field values. Valid option values: numbers, letters, email_address, us_phone_number, us_zip_code, us_age, and alphanumeric. Not applicable for autofill fields. |
| 10 | Fixed Width | Width of text fields automatically grow to fit content by default. You can force text width to stay the same and text to wrap into new lines by setting this option to y. Default is n. |
Additional date field options (only for date fields):
| Order | Name | Description |
|---|---|---|
| 9 | Lock Signing Date/ Autofill Date Signed | You can automatically have date fields populate with the signing date of the document and prevent changes by setting this field option to y. Default is n. |
| 10 | Date Format | Valid values: mm/dd/yyyy,dd/mm/yyyy,yyyy/mm/dd, and mm/dd/yyyy hh:mm:ss. |
| 11 | Formula | A way to prefill fields with calculated future or past dates. Addition, subtraction, and parentheses are allowed. Valid event dates are created_date, sent_date, and signed_date. Valid time periods are day, days, week, weeks, month, and months. Example: formula: sent_date + 10 days. Use with lock_sign_date if you'd like to make the field readonly and prevent signers from choosing a different date. |