Add a field to a template

Request Body

application/json

Body Parameters

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Name for the new field. Field names must be unique within a template. Although special characters are allowed, they must be URL-encoded in subsequent requests, so it is recommended to use only alphanumeric characters and hyphens if possible.

role_name*string

Role to assign to the field. Role names must be valid, so it is recommended to create roles before fields.

document_id*string

ID of the document upon which to place the field.

type*string

Type of field to create

Value in

"signature" | "initial" | "checkbox" | "radio" | "textbox" | "timestamp" | "date" | "dropdown" | "textarea" | "attachment" | "payment"

required*boolean

Whether the field is required

Default"false"

page*integer

0-based page number upon which to place the field

x*integer

X position for the field (left to right)

y*integer

Y position for the field (bottom to top!)

label?string

Optional label to display above the field

width?integer

Width of the field. Note that all fields have built-in defaults, and it is recommended that this only be set on text fields.

height?integer

Height of the field. Note that all fields have built-in defaults, and it is recommended that this only be set on text fields.

placeholder?string

Optional placeholder to display in text fields

group?string

For fields that support grouping (radio buttons and check boxes) the value selected will be stored under this name

options?array<>

For dropdown fields, the options to display

default?string

Default value to pre-fill in the field. For checkboxes and radio buttons, true or "true" starts checked. Numbers are stored as text with thousands separators, e.g. "1,234.50". A date field given an ISO 8601 date starts out showing it as MM/dd/yyyy.

readonly?boolean

Whether recipients are prevented from changing the field. May not be combined with required.

Default"false"

validator?string

Name of a validator to apply to the field's value (e.g. "email" or "phone")

data_key?string

Your key for the field's value, such as "applicant.full_name". Fields that show the same value can share a key. Letters, digits, "_", and "-", with "." between levels. Text, date, checkbox, radio, and dropdown fields only.

Response Body

`application/json`

curl -X POST "https://api.verdocs.com/v2/fields/TEMPLATE_ID" \    -H "Authorization: Bearer ACCESS_TOKEN" \    -H "content-type: application/json" \    -d '{"param": "value"}'

{
  "config": "string",
  "data_key": "string",
  "default": "string",
  "document_id": "string",
  "group": "string",
  "height": 0,
  "multiline": true,
  "name": "string",
  "options": "string",
  "placeholder": "string",
  "readonly": "string",
  "role_name": "string",
  "settings": "string",
  "template_id": "string",
  "width": 0,
  "x": 0,
  "y": 0
}

{
  "status": "ERROR",
  "error": "string"
}

{
  "status": "ERROR",
  "error": "string"
}

{
  "status": "ERROR",
  "error": "string"
}

{
  "status": "ERROR",
  "error": "string"
}

Add a field to a template

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

404application/json

406application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`