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

https://api.pandadoc.com

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[].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"`
`fields[].settings`	Object	No	Field configuration. The available properties depend on the field `type`.
`fields[].settings.placeholder`	String	No	Placeholder text shown in the field. Applies to text, date, dropdown, payment, and collected file fields.
`fields[].settings.required`	Boolean	No	Whether the recipient must complete the field. Default value: true
`fields[].settings.options[]`	Array	No	Selectable options. Applies to `radio_buttons` and `dropdown` fields. For `radio_buttons`, include a `position` for each option to place it on the page.
`fields[].settings.options[].text`	String	Yes	Option label.
`fields[].settings.options[].position`	Object	No	Option position relative to the field. Used by `radio_buttons` fields.
`fields[].settings.options[].position.offset_x`	Number	No
`fields[].settings.options[].position.offset_y`	Number	No
`fields[].settings.show_values`	Boolean	No	Show the option values next to the radio buttons. Applies to `radio_buttons` fields. Set to `false` to hide the values. Default value: true
`fields[].settings.multiline`	Boolean	No	Allow the value to span multiple lines. Applies to text fields.
`fields[].settings.masked`	Boolean	No	Hide the entered value behind a mask. Applies to text and date fields.

How to start integrating

Add HTTP Task to your workflow definition.
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.
Click Test request to test run your request to the API and see the API's response.