Skip to main content
PATCH
Rename 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

number
string
required

The form template's stable FM-XXXX number (as returned by the Upload Form Template endpoint). It identifies the template across all of its versions and is the same value forms-logic rules reference.

Body

application/json
name
string
required

The form's new display name. Surrounding whitespace is trimmed; the trimmed name must not be empty.

Response

Form renamed. The response is the form's current-version summary.

A form-library entry: a form-template summary augmented with its current version and its kind (DOCX template vs static PDF).

templateKey
string<uuid>
required

Stable identifier of the template across its versions.

checkpointId
string<uuid>
required

Identifier of this specific checkpoint (version) of the template.

companyId
string<uuid>
required
name
string
required

Display name (derived from the uploaded file name).

number
string
required

Human-facing form number (e.g. FM-0010).

category
enum<string>
required

The form category assigned to the template.

Available options:
event,
quote-flow,
quote-bind-flow,
insured,
submission,
person,
organization,
unknown
storagePath
string
required

Internal storage key of the checkpoint's document.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
version
integer
required

The current checkpoint's version number.

kind
enum<string>
required

template — a DOCX form template (carries smart tags); static — a static PDF used as-is. Selects which replace endpoint applies (/forms/template/{number} vs /forms/static/{number}).

Available options:
template,
static
createdBy
string | null
updatedBy
string | null