Verdocs - Update a field. See createField for additional details on the supported parameters.

Request Body

application/json

Body Parameters

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Rename the field. Note that template field names must be unique within a template.

role_name*string

Role to assign to the field.

document_id*string

ID of the document upon which to place the field.

type?string

Change the field type. Note that while this is technically allowed, fields have different behaviors, validators, default sizes, etc. It is usually easier to add a new field and delete the old one.

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

value?string

Optional default value to set on the field

Response Body

`application/json`

curl -X PATCH "https://api.verdocs.com/v2/fields/{template_id}/{field_name}" \  -H "Content-Type: application/json" \  -d '{    "role_name": "string",    "document_id": "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"
}

Update a field. See createField for additional details on the supported 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`