Sign in
Start free7-day free trial
API RESOURCE

Templates

Create a form, save its draft and publish a version. Signed records remain connected to the version used at signing.

Read the implementation guide
GET

List templates

/v1/templates

Every template in the organization except archived ones, by name. activeVersion is the version number currently published, or null while a template has only ever been a draft.

POST

Create a template

/v1/templates

Creates an empty template. It has no version yet: save its blocks with PUT /v1/templates/{id}/draft and publish it before anything can be signed against it.

GET

Retrieve a template

/v1/templates/{id}

One template with its settings and the blocks of its active published version. activeVersion is null until the template has been published at least once. an unpublished draft is never returned here.

PUT

Save a template draft

/v1/templates/{id}/draft

Replaces the template's draft blocks, validated exactly as the dashboard builder validates them. The published version. and every waiver signed under it. is untouched until you publish.

POST

Publish a template version

/v1/templates/{id}/publish

Publishes the current draft as a new version. Versions are immutable and waivers keep pointing at the version they were signed under, so publishing never rewrites history. 409 for an archived template: unarchive it first, so that restoring a retired document is a deliberate, separately recorded act.

POST

Archive a template

/v1/templates/{id}/archive

Archives a template: it immediately stops accepting new signatures. the public signing page 404s. and drops off GET /v1/templates. Already-signed waivers are untouched and keep pointing at the version they were signed under.

POST

Restore an archived template

/v1/templates/{id}/unarchive

Restores an archived template: active again if it has a published version, otherwise back to draft.

Before you connect

Use the scopes shown on each endpoint. Read the response schema and common errors, and keep mutations separate from diagnostic read requests.

AuthenticationError handlingOpenAPI contract