Date Field API

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

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

Date field example

<field
    type="datetime"
    name="delivery_date"
    placeholder="Select delivery date"
    roleId="fd8cb669-db1d-41e1-8f6c-2ad3f8fa981a"
    optional="false"
    time="true"
    search="true"
    min="0"
    max="30"
/>

Required attributes

• type — field type. Use datetime.

• 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.

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.

• time — set to true if the field should accept a time value together with the date.

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

• min — minimum day offset allowed from the envelope creation date.

• max — maximum day offset allowed from the envelope creation date.

Validation rules

• min and max support values from -9999 to 9999.

• min and max define day offsets from the envelope creation date.

Value format

Use ISO 8601 values, such as:

• 2019-12-31T23:59:59+02:00

• 2019-12-31T23:59:59Z

Related topics

• Template Dynamic Fields API

• Template Structure API

• Send Envelope

• Fill Envelope