POST /public/v1/documents/{id}/fields

Creates fields for a particular document. For CFR11-compliant workspaces (21 CFR Part 11), signature fields must have a minimum size of 108×33.

Servers

Path parameters

Name Type Required Description
id String Yes

Document UUID.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
fields[] Array No

An array of fields to place on a document.

fields[].placeholder String No
fields[].assigned_to String No

Optional uuid of a recipient.

fields[].merge_field String No

Use this to dynamically populate this field with data from your CRM or API. Supported field types:

  • text
  • checkbox
  • date
  • dropdown
  • radio_buttons
fields[].field_id String No

Optional unique identifier.

fields[].layout Object Yes
fields[].layout.page Integer Yes
fields[].layout.position Object Yes
fields[].layout.position.anchor_point String Yes

Valid values:

  • "bottomleft"
  • "bottomright"
  • "topright"
  • "topleft"
fields[].layout.position.offset_x Number Yes
fields[].layout.position.offset_y Number Yes
fields[].layout.style Object Yes
fields[].layout.style.height Integer Yes
fields[].layout.style.width Integer Yes
fields[].type String Yes

Valid values:

  • "stamp"
  • "date"
  • "checkbox"
  • "text"
  • "dropdown"
  • "payment_details"
  • "radio_buttons"
  • "initials"
  • "signature"
  • "collect_file"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.