Documents

Fill fields

Sets values by field name. Values are validated like in the editor (types, options, formats, patterns; formulas recalculated). If anything is invalid you get 422 invalid_fields with a message per field and nothing is saved. complete: true also requires every required field.

Signature and button fields in the PDF can't be filled through the API — send a signature request instead.

put/v1/documents/{id}/fields/

Request

  • Base URL: https://api.pdfbetter.com
  • URL: https://api.pdfbetter.com/v1/documents/{id}/fields/
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

valuesobject required
completeboolean
expectedRevisioninteger

Response

Fill fields

object'field_list' required
documentIdstring required
revisioninteger required

Document revision; pass as expectedRevision to fill safely

updatedstring[]

Fields changed by this request (fill only)

Changes

No recorded changes to this operation across all 1 revision of this API.