Skip to main content
PATCH
Add, update, or remove boxes on a PDF field

Authorizations

Authorization
string
header
required

Personal API key, e.g. Authorization: Bearer sajn_sk_.... Not scope-limited — acts as the issuing user.

Headers

authorization
string
required

Bearer token for API authentication

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.

Maximum string length: 255

Path Parameters

id
string
required
fieldId
string
required

Body

application/json

Body

upsert
object[]
required

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.

Maximum array length: 500

A box placed on a page of a PDF field

remove
string[]
required

Ids of boxes to remove from the field.

Maximum array length: 500
Minimum string length: 1

Response

200

id
string
required

The PDF field id

type
enum<string>
required
Available options:
TEXT,
HTML,
FORM,
PDF,
PRODUCT_TABLE,
TABLE,
SPACER,
PAGE_BREAK,
DURATION
position
number
required
fieldMeta
object
required

The PDF field metadata after the change, including every box in placedFields

documentId
string
required