Fill in values on a document
Fills in values by key. The same request shape works for FORM subfields, AcroForm fields, and boxes placed on a PDF. Only documents with the status DRAFT or IMPORTED can be filled in.
Keys must match exactly. To find the keys, call GET /api/v1/documents/{id}/field-values. Set a key in the editor on a FORM subfield or a placed box, or send key when you create a placed box through the API, so that the key stays the same for every document created from a template.
The following example fills in a FORM subfield, a placed text box, and a PDF checkbox:
A value fails, and the other values are still written, when its key doesn’t exist, when two fields share the key, when a party fills in the value and the document is no longer a draft, or when the value doesn’t match the type or the allowed options. results lists the outcome for each key, with an error that has a code from the error catalogue, and data holds every value on the document after the write, as GET /api/v1/documents/{id}/field-values returns them.
If another edit changes one of the fields while the request runs, nothing is written and the request fails with an HTTP 409 Conflict status code. Send the request again.
Authorizations
Headers
ID of the workspace this request acts in, from GET /api/v1/workspaces. Without it, an API key acts in its default workspace. The token's user must be a member of the workspace; an OAuth token only accepts the workspace it was granted for. A workspace that doesn't exist or can't be reached returns 403 WORKSPACE_ACCESS_DENIED.
Body
Body

