Skip to main content
PATCH
Update a document field

Authorizations

Authorization
string
header
required

OAuth 2.0 access token for a connected application. Limited to the scopes granted at consent.

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

type
enum<string>

Field type

Available options:
TEXT,
HTML,
FORM,
PDF,
PRODUCT_TABLE,
TABLE,
SPACER,
PAGE_BREAK,
DURATION
position
number

Field position/order

key
string

Unique key identifier for API access

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

Field-specific metadata. By id: the full metadata for the field type. For FORM subfield updates via the key: prefix, pass the subfield structure to merge (e.g., {"type": "input", "value": "new value"}).

Response

Error response

Error response

message
string
required

Error message describing what went wrong

code
string

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

errorId
string

Identifier for this occurrence — quote it to support when reporting a 500