Update a document field

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": {
    "type": "TEXT",
    "content": "<string>"
  }
}'

{
  "message": "<string>"
}

Document Fields

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

Key-Based Updates: For FORM fields with subfield keys, use key:your-field-key as the fieldId to update a specific subfield by its key instead of database ID.

PATCH

api

documents

{id}

fields

{fieldId}

Update a document field

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": {
    "type": "TEXT",
    "content": "<string>"
  }
}'

{
  "message": "<string>"
}

Headers

authorization

string

required

Bearer token for API authentication

Path Parameters

string

required

fieldId

string

required

Body

application/json

Body

type

enum<string>

Available options:

TEXT,

FORM,

PDF,

PRODUCT_TABLE,

TABLE

position

number

key

string

fieldMeta

object

Option 1
Option 2
Option 3
Option 4
Option 5

Show child attributes

Response

Error response

message

string

required

Error message describing what went wrong

Create a document field Delete a document field

⌘I

Introduction

System

Documents

Document Signers

Document Fields

Document Tags

Contacts

Companies

Tags

Custom Fields

sajn ID

Update a document field

Headers

Path Parameters

Body

Response