Skip to Content
Document content

Add, update, or remove boxes on a PDF block

PATCH
/api/v1/documents/{id}/content/{contentId}/placed-fields

Changes individual boxes on a PDF field without sending the whole field. Only DRAFT documents can be changed.

Each box in upsert has the same shape as an entry in fieldMeta.placedFields on POST /api/v1/documents/{id}/content, and is checked the same way. The response is the updated field, in the same shape as GET /api/v1/documents/{id}/content/{contentId}. A box whose id already exists on the field replaces that box and keeps its stacking order. A box with a new id is added on top. remove lists the ids of boxes to delete. Boxes you don't mention stay as they are.

The change is atomic: if any box is invalid, nothing is written and the response lists every problem in issues. If another edit changes the field while the request runs, the request fails with an HTTP 409 Conflict status code and code INVALID_STATE; send it again.

Example - move one box and remove another:

PATCH /api/v1/documents/{docId}/content/{contentId}/placed-fields{  "upsert": [    {      "id": "sig-1",      "kind": "INPUT",      "inputType": "SIGNATURE",      "page": 2,      "rect": { "x": 0.12, "y": 0.8, "width": 0.34, "height": 0.06 },      "partyId": "PARTY_ID"    }  ],  "remove": ["initials-3"]}

Authorization

headerAuthorizationBearer <token>

API key, e.g. Authorization: Bearer sajn_svc_.... Not scope-limited: acts with its owner's workspace role.

Path Parameters

id*string

The document ID.

contentId*string

The content block ID.

Header Parameters

Sajn-Version?string

API version for this request. Without it, the request uses the organization's default version; an organization without a default is pinned to the latest version by its first request.

Value in"2026-09""2026-10"
Sajn-Workspace?string

ID of the workspace this request acts in, from GET /api/v1/workspaces. Without it, an API key acts in its default workspace. The token's user must be a member of the workspace; an OAuth token only accepts the workspace it was granted for. A workspace that doesn't exist or can't be reached returns 403 WORKSPACE_ACCESS_DENIED.

Idempotency-Key?string

Makes retries safe. A retry with the same key and the same request replays the stored response for 24 hours (header Idempotent-Replayed: true); the same key with a different request returns 400.

Lengthlength <= 255

Request Body

Body

application/json
  1. body
upsert?array<|>

Boxes to add or replace. A box whose id already exists on the field replaces that box and keeps its stacking order; any other box is added on top.

Itemsitems <= 500
remove?array<>

Ids of boxes to remove from the field.

Itemsitems <= 500
Default[]

Response Body

200

application/json
  1. response
id*string

Unique field identifier

documentId*|

Document this field belongs to

templateId*|

Template this field belongs to

type*string

Field type

Value in"TEXT""HTML""FORM""PDF""PRODUCT_TABLE""TABLE""SPACER""PAGE_BREAK""DURATION"
position*number

0-based index of the block among the content blocks. Positions are unique and have no gaps.

fieldMeta*|||||||||

Type-specific content. For PDF fields this includes placedFields (boxes placed on the PDF pages) and formFields (form fields extracted from the PDF).

createdAt*|

Date and time when the field was created

Formatdate-time
updatedAt*|

Date and time when the field was last updated

Formatdate-time
Example Request
curl -X PATCH 'https://app.sajn.se/api/v1/documents/cm4k2x9p10003abcd1234efgh/content/cm4k2x9p10009abcd1234efgh/placed-fields' \  -H 'Content-Type: application/json' \  -d '{  "upsert": [    {      "id": "cm4k2x9p10009abcd1234efgh",      "page": 1,      "rect": {        "x": 0.12,        "y": 0.76,        "width": 0.3,        "height": 0.06      },      "pageWidth": 595.28,      "pageHeight": 841.89,      "pageRotation": 0,      "name": "Anställningsvillkor",      "key": "startdatum",      "locked": false,      "style": {        "fontSize": 6,        "color": "#2563EB",        "bold": false,        "italic": false,        "align": "LEFT"      },      "kind": "INPUT",      "inputType": "TEXT",      "label": "Startdatum",      "fillSource": "SIGNER",      "partyId": "cm4k2x9p10004abcd1234efgh",      "variableId": "startdatum",      "identity": "name",      "drawn": false,      "required": true,      "options": [        "Heltid"      ],      "multiline": false,      "format": "email",      "min": 1,      "max": 1,      "decimals": 1,      "step": 1,      "unit": "RELATIVE",      "origin": "TOP_LEFT"    }  ],  "remove": [    "Anställningsvillkor"  ]}'
Example Response
{  "id": "cm4k2x9p10009abcd1234efgh",  "documentId": "cm4k2x9p10003abcd1234efgh",  "templateId": null,  "type": "TEXT",  "position": 0,  "fieldMeta": {    "type": "TEXT",    "content": "<p>Anställningen gäller tills vidare från och med den 1 november 2026, med sex månaders provanställning.</p>"  },  "createdAt": "2026-09-28T09:12:00.000Z",  "updatedAt": "2026-09-28T09:12:00.000Z"}

Was this page helpful?