Skip to main content
PATCH
Rename one field of a template.

Authorizations

Authorization
string
header
required

Authorization: Bearer vsk_live_…. Chosen over a bespoke X-API-KEY header because every client, proxy and log-redaction rule already knows this one. What a key may DO is its scopes — see x-scopes at the root of this document and x-required-scope on each operation. The scope list is not written here because OpenAPI reserves a requirement’s scope array for oauth2 and openIdConnect and requires it to be empty for an http scheme.

Headers

If-Match
string
required

The ETag of the template you read. ⚠️ REQUIRED: without it, or with *, the answer is precondition_required. When it is no longer current the answer is template_changed with the current ETag, and nothing is renamed — unless every name you sent is already the stored one, which is what a retry of a rename that succeeded looks like, and is answered 200. An entity tag, quoted.

Path Parameters

templateId
string<uuid>
required

The template’s id, as returned by the list endpoint. A template id.

Example:

"01960000-0000-4000-8000-0000000007e1"

fieldId
string
required

The field’s id, from fields[].id of the template. Not one of this template’s — a malformed id included — is field_unknown. A field id.

Body

application/json

The field’s names to change.

One field’s names.

data_key
string | null

The address values are written to, or null to remove it. A new key follows the naming grammar (namespace.attribute or namespace.entity.attribute, snake_case) and is not in a core namespace or a subject key’s; the key a field already has may be kept. Not on a field nobody may prefill, and not on a box in a question.

Required string length: 1 - 100
label
string | null

What the sender reads beside the box, or null to remove it. Not blank.

Required string length: 1 - 200
subject
string | null

A subject key declared on this template (subjects[].key), or null for the signer’s own. Not changed on a field nobody may prefill: there the subject decides whether the field must be completed.

Minimum string length: 1

Response

The template as it now stands, with its new ETag.

The template, in full.

id
string<uuid>
required

The template’s id. A bare uuid, no prefix.

name
string
required

What the sender called it.

created_at
string<date-time>
required

ISO 8601, UTC. Also the order this list is in — newest first.

warnings
object[]
required

What the template’s upload warned about, kept with the template: on the create response and on every read, so a template somebody uploaded on the dashboard says here what its upload said. Empty when there was nothing to say, and always present. A retry of the create’s Idempotency-Key answers with the same list.

Maximum array length: 10
documents
object[]
required

The pack, in the order it is stacked.

pages
object[]
required

⚠️ THE DENOMINATOR FOR EVERY Field.rect, and a client doing field matching cannot skip it: a rectangle of fractions is dimensionless without the page it is a fraction of. Join on (document_id, page), the same pair fields is joined by.

Every page of every document of the pack, in the pack’s order and then by page number — the order a signer scrolls.

roles
object[]
required

The signing roles, in routing order.

subjects
object[]
required

The people whose data this template collects.

questions
object[]
required

The tickbox questions and how many answers each takes.

fields
object[]
required

⚠️ A FLAT LIST, NOT A MAP KEYED BY ADDRESS. Several fields sharing one (subject, data_key) pair is NORMAL — real forms ask for an ID number on the application and again on the declaration, and initials in the footer of all nine pages. A value supplied for an address means it for every box that asks.

coverage
object
required

How much of the template your integration can address, counted by the same code as the editor’s coverage line, so the two always agree. Part of the body, so the template’s ETag changes when it does.