Skip to Content

Update a template field

You're viewing API version 2026-09, which is deprecated and stops working on October 1, 2027. To move your integration, see Upgrading to 2026-10.
PATCH
/api/v1/templates/{id}/fields/{fieldId}

Update a template field's properties. Supports key: prefix for FORM subfield updates, same as the documents endpoint.

Authorization

headerAuthorizationBearer <token>

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

Path Parameters

id*string
fieldId*string

Header Parameters

authorization*string

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.

Lengthlength <= 255

Request Body

Body

application/json
  1. body
type?string

Field type

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

Field position/order

key?string

Unique key identifier for API access

Match^[a-z0-9_-]*$
fieldMeta?|||||||||

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 Body

Error response

application/json
  1. response

Error response

message*string

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

issues?array<>

Every validation issue, on a 400 for an invalid request

requiredScopes?array<string>

OAuth scopes the endpoint requires, on a 403 for a missing scope

grantedScopes?array<string>

OAuth scopes the token was granted, on a 403 for a missing scope

Example Request
curl -X PATCH 'https://app.sajn.se/api/v1/templates/string/fields/string' \  -H 'authorization: string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "message": "string",  "code": "string",  "errorId": "string",  "issues": [    {      "path": "string",      "message": "string"    }  ],  "requiredScopes": [    "string"  ],  "grantedScopes": [    "string"  ]}

Was this page helpful?