Skip to main content
POST
Upload Static 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

Body

application/json
fileName
string
required

Original file name, including the .pdf extension. Used as the form's display name. Must be non-empty.

fileBase64
string
required

The raw .pdf bytes, base64-encoded.

category
enum<string>
required

The form category — classifies the static form the same way a template is classified.

Available options:
event,
quote-flow,
quote-bind-flow

Response

Static form created

A single form-template checkpoint.

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,
unknown
storagePath
string
required

Internal storage key of the checkpoint's document.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
createdBy
string | null
updatedBy
string | null