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 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:

PATCH /api/v1/documents/{docId}/fields/{fieldId}
{
  "type": "TEXT",
  "fieldMeta": {
    "type": "TEXT",
    "content": "<p>Updated content</p>"
  }
}

Example - Update HTML field:

PATCH /api/v1/documents/{docId}/fields/{fieldId}
{
  "type": "HTML",
  "fieldMeta": {
    "type": "HTML",
    "content": "<div style='text-align: center'><h1 style='color: #003366'>Contract Title</h1><img src='https://example.com/logo.png' alt='Company Logo' style='max-width: 200px' /><p>Custom styled content with <span style='color: red'>highlighted text</span></p></div>"
  }
}

Example - Update FORM field:

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:

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.

PATCH /api/v1/documents/{id}/fields/{fieldId}

Update a document field

cURL

curl --request PATCH \
  --url https://app.sajn.se/api/v1/documents/{id}/fields/{fieldId} \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '
{
  "type": "TEXT",
  "position": 123,
  "key": "<string>",
  "fieldMeta": "<unknown>"
}
'

400

{
  "message": "<string>"
}

Headers

authorization · string · required

Bearer token for API authentication

Path Parameters

id · string · required

fieldId · string · required

Body

application/json

Body

type · enum<string>

Field type

Available options: TEXT, HTML, FORM, PDF, PRODUCT_TABLE, TABLE

position · number

Field position/order

key · string

Unique key identifier for API access

Pattern: ^[a-z0-9_-]*$

fieldMeta · any

Field-specific metadata. For FORM subfield updates via key: prefix, pass the subfield metadata structure with properties like type and value (e.g., {"type": "input", "value": "new value"}).

Response

400

application/json

Error response

Error response

message · string · required

Error message describing what went wrong