Create a document field

Add a field/section to a document. Can create single field or multiple fields at once.

Field Types:

• TEXT - Rich text content section (Tiptap editor format)
• HTML - Raw HTML content with custom styling (API-only, sanitized for security)
• FORM - Form with input fields for signers
• PDF - PDF file section
• PRODUCT_TABLE - Product/service table with pricing

Field Position: Determines the order fields appear in the document (0-based index).

Field Metadata: Each field type has specific metadata requirements. See schema documentation for details.

HTML Field Security: HTML fields accept raw HTML but are automatically sanitized server-side to allow only safe formatting tags (p, div, span, headings, lists, tables, images) and basic CSS styling. Links, script tags, and dangerous attributes are stripped. Images support HTTP/HTTPS URLs and data URIs for inline images.

POST /api/v1/documents/{id}/fields

Create a document field

cURL

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

400

{
  "message": "<string>",
  "code": "<string>"
}

Headers

authorization · string · required

Bearer token for API authentication

Path Parameters

id · string · required

Body

application/json

Body

object

object[]

type · enum<string> · required

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

position · number · required

fieldMeta · object · required

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Show child attributes

key · string

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

Response

400

application/json

Error response

Error response

message · string · required

Error message describing what went wrong

code · string

Machine-readable error code (e.g. APPROVAL_REQUIRED)