Update a document field
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 withkey:)- Example:
/api/v1/documents/{docId}/fields/key:recipient-name
Updatable Properties:
type- Field type (cannot change if field has data)position- Field order/positionfieldMeta- Field-specific metadatakey- 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:
Example - Update HTML field:
Example - Update FORM field:
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:
This will update only the value property of the subfield with key “name”, preserving all other properties like label, placeholder, and description.
Authorizations
Headers
Body
Body
Response
Error response
Error response

