Document Editor and Fields

Document editor and fields

Fields show recipients where to sign or provide information. The editor overlays fields on PDF pages or the document preview; it does not replace the legal text of your agreement.

Place a field

1. Open an editable agreement and its document editor.
2. Add or select a recipient.
3. Choose the field type from the field controls.
4. Place it on the intended page, then move or resize it to fit the document.
5. Open its properties and set its label, placeholder, required setting, and any available validation.
6. Confirm the field belongs to the intended recipient.
7. Save, then review every page and recipient before sending.

Use descriptive labels such as “Full legal name” instead of “Text 1”. Leave enough space for realistic answers and signatures. Use recipient colors as a visual aid, then check the actual assignment in properties.

Field types

Field	What the recipient supplies	Preparation tip
Signature	Their signature representation	Place where the document requires signature
Initials	Initials	Use for page or clause acknowledgement
Text	A written answer	Add a helpful label and sensible length rules
Date	A date	Check the configured date format
Company	Organization information	Clarify the intended company name
Email	An email address	Use email validation where appropriate
Checkbox	A checked or unchecked answer	Explain what checking it means
Radio	One choice in a group	Configure meaningful choices and a group name
Dropdown	A choice from a list	Configure option labels and values

The field schema supports these nine types. UI exposure and advanced properties can vary by deployment; preview the actual signer experience before using a new field type.

Required fields and validation

A required field must be completed before signing can finish. Text validation supports available email, number, length, and pattern rules. Radio buttons and dropdowns need options. A field with an unclear label or impossible validation rule can prevent a signer completing the document.

The schema also includes conditional rule definitions. Do not assume conditional visibility or requirements are available in every editor and signer flow; see Feature Availability.

Before you send

• Verify content, page order, and recipient email addresses.
• Make sure each field is assigned to a recipient who will receive the document.
• Confirm required fields and choices work as intended.
• Check placement at the expected page size and preview zoom.
• Save changes before leaving the editor.

Developer notes

Read or save fields through GET or PUT /api/v1/agreements/{id}/fields. The save body contains fields and recipients arrays. Each field references an existing recipient ID; field IDs must be unique. Page numbers start at 1. Coordinates and dimensions are percentages: x and y are 0–100, and width and height are 1–100.

For payloads and permissions, use Agreement and Workflow API.