Update a document field's properties. Only DRAFT documents can have fields updated. **Field Identifier:** - `fieldId` - Can be either database ID or key-based reference (prefix with `key:`) - Example: `/api/v1/documents/{docId}/fields/key:recipient-name` **Updatable Properties:** - `type` - Field type (cannot change if field has data) - `position` - Field order/position - `fieldMeta` - Field-specific metadata - `key` - Unique key identifier for API access **Regular Field Updates (by ID):** Pass the full field structure including type and complete fieldMeta for that field type. **Example - Update TEXT field:** ```json PATCH /api/v1/documents/{docId}/fields/{fieldId} { "type": "TEXT", "fieldMeta": { "type": "TEXT", "content": "

Updated content

" } } ``` **Example - Update HTML field:** ```json PATCH /api/v1/documents/{docId}/fields/{fieldId} { "type": "HTML", "fieldMeta": { "type": "HTML", "content": "

Contract Title

Custom styled content with highlighted text

" } } ``` **Example - Update FORM field:** ```json PATCH /api/v1/documents/{docId}/fields/{fieldId} { "type": "FORM", "fieldMeta": { "type": "FORM", "columns": 2, "fields": [...] } } ``` **Key-Based Updates for FORM Subfields:** For FORM fields with subfield keys, use `key:your-field-key` as the fieldId to update a specific subfield by its key. When updating a FORM subfield by key, only pass the `fieldMeta` property with the subfield's metadata structure. All other properties (type, position, key) are ignored. **Example - Update FORM subfield value:** ```json PATCH /api/v1/documents/{docId}/fields/key:name { "fieldMeta": { "type": "input", "value": "Andreas" } } ``` This will update only the `value` property of the subfield with key "name", preserving all other properties like label, placeholder, and description.

Documentation Index

Headers

Path Parameters

Body

Response