Leum gu prìomh susbaint

FieldInput

Pre-fill a field value on a document being sent. Used for both sender fields (senderFields) and participant fields (participantFields) in DocumentSendSettingsInput.

Fields​

FieldTypeRequiredDefaultDescription
idID!Yes—UUID of the original template element
valueStringNo—Value to pre-fill
labelStringNo—Field label
signerIntNo—Signer index for this field
elementTypeStringNo—Field type
roleIdStringNo—Assign to a specific role (e.g. convert sender field to signer field)

Validation Rules​

  • id must be a base64-encoded element ID that decodes to ele followed by a UUID.
  • roleId, when supplied, must be a base64-encoded role ID that decodes to rol followed by a UUID.

Example​

senderFields: [
{ id: "ZWxlbWVudC0x", value: "Acme Corp", label: "Company Name" }
{ id: "ZWxlbWVudC0y", value: "2025-07-01", label: "Start Date" }
]

Export This Article

Save a copy of this page as PDF or plain text.