Skip to main content
POST
Touch Generated Form

Authorizations

Authorization
string
header
required

API key authentication. Send your raw API key as the Authorization header value with NO scheme prefix — Authorization: YOUR-API-KEY. Do NOT prefix it with Bearer or ApiKey, and do not use an X-API-Key header; those are not accepted.

Path Parameters

companyId
string<uuid>
required

Company identifier

id
string<uuid>
required

The generated form's id (as returned by the List Generated Forms endpoint). Identifies one generated form instance — not a template; templates are addressed by their FM-XXXX number instead.

Response

The touch outcome. changed is true when anything was written — anchors renamed in the Working Document and/or metadata refreshed.

id
string<uuid>
required

The touched generated form's id.

changed
boolean
required

True when the touch wrote anything (anchors renamed and/or metadata refreshed); false when the form was already up to date.

renamedTags
string[]
required

The legacy smart-tag identities that were converged to the hashed format, one entry per unique identity. Empty when the Working Document was already converged.

metadataRefreshed
boolean
required

True when the form's cached smart-tag metadata was brought up to date.