Update a template field (including binding_key)

Patch label/required/properties on a template field. Set properties.binding_key to bind the field to an external proposal key (GitHub #604).

PUT/templates/fields/update

Authorization

AuthorizationBearer token · headerrequired

Pass your API key as a Bearer token. API keys are scoped to specific operations — configure scopes in your organization's Settings → Developer → API Keys.

Request body

requiredapplication/json

template_idstringrequired

field_idstringrequired

labelstring

is_requiredboolean

propertiesobject

Show properties

placeholderstring

default_valuestring

optionsstring[]

binding_keystring

Responses

200

Updated field

fieldTemplateField

Show properties

idstringrequired

field_typeFieldTyperequired

Allowed:signaturetextdatecheckboxdropdownradioattachment

labelstring

is_requiredbooleanrequired

pageintegerrequired

Page number (1-indexed)

xnumberrequired

X position as a fraction of page width (0–1)

ynumberrequired

Y position as a fraction of page height (0–1)

widthnumberrequired

Width as a fraction of page width (0–1)

heightnumberrequired

Height as a fraction of page height (0–1)

propertiesobject

Free-form field properties. Use binding_key to bind a fillable field to an external proposal/deal key (programmatic sync instead of agentic OCR reconstruction — see GitHub #604).

Show properties

placeholderstring

default_valuestring

optionsstring[]

binding_keystring

External structured-data key (e.g. a Vortex Payments proposal field). When set, agents/integrations write this field from the bound source instead of guessing via OCR.

401

Missing or invalid API key

typestringrequired

Machine-readable error code

statusintegerrequired

HTTP status code

titlestringrequired

Human-readable error message

detailsobject

Field-level validation errors

404

Resource not found

typestringrequired

Machine-readable error code

statusintegerrequired

HTTP status code

titlestringrequired

Human-readable error message

detailsobject

Field-level validation errors

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Bodyapplication/json

Request body

Request

curl -X PUT "https://api.seal.nyc/api/v1/templates/fields/update" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "template_id": "string",
  "field_id": "string",
  "label": "string",
  "is_required": true,
  "properties": {
    "placeholder": "string",
    "default_value": "string",
    "options": [
      "string"
    ],
    "binding_key": "string"
  }
}'

const response = await fetch("https://api.seal.nyc/api/v1/templates/fields/update", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"template_id\": \"string\",\n  \"field_id\": \"string\",\n  \"label\": \"string\",\n  \"is_required\": true,\n  \"properties\": {\n    \"placeholder\": \"string\",\n    \"default_value\": \"string\",\n    \"options\": [\n      \"string\"\n    ],\n    \"binding_key\": \"string\"\n  }\n}"
});

import requests

response = requests.put(
    "https://api.seal.nyc/api/v1/templates/fields/update",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"template_id\": \"string\",\n  \"field_id\": \"string\",\n  \"label\": \"string\",\n  \"is_required\": true,\n  \"properties\": {\n    \"placeholder\": \"string\",\n    \"default_value\": \"string\",\n    \"options\": [\n      \"string\"\n    ],\n    \"binding_key\": \"string\"\n  }\n}",
)

Response

{
  "field": {
    "id": "string",
    "field_type": "signature",
    "label": "string",
    "is_required": true,
    "page": 0,
    "x": 0,
    "y": 0,
    "width": 0,
    "height": 0,
    "properties": {
      "placeholder": "string",
      "default_value": "string",
      "options": [
        "string"
      ],
      "binding_key": "string"
    }
  }
}

{
  "type": "AUTH_ERROR",
  "status": 401,
  "title": "Missing or invalid API key"
}

{
  "type": "NOT_FOUND",
  "status": 404,
  "title": "Document not found"
}