Templates

A template is a reusable envelope blueprint. It defines the document layout, field positions, and recipient roles once — so that every envelope created from it requires only the variable information (the actual signers) at send time.

Properties

Property	Type	Description
`templateId`	string	Unique identifier for the template.
`name`	string	Display name (2–48 characters).
`description`	string	Optional description shown in the UI.
`teamScope`	string[]	List of team IDs within the workspace that are allowed to use this template.

The `teamScope` field

Inspakt workspaces can contain multiple teams. The teamScope array controls which teams have access to this template. Provide an empty array or omit it to restrict access to the owning team only; include additional team IDs to share the template across teams.

{
  "name": "Standard NDA",
  "teamScope": ["team_hr", "team_legal"]
}

Templates vs. envelopes

	Template	Envelope
Purpose	Reusable blueprint	Single signing session
Documents	Pre-configured	Uploaded per envelope (or inherited from template)
Fields	Pre-configured	Defined per envelope (or inherited from template)
Recipients	Pre-configured roles (optionally fixed)	Actual persons assigned per send
Lifecycle	Static — no status	`draft → sent → finalized / voided / expired`

Creating a template

POST /api/v1/key/templates
Content-Type: application/json

{
  "name": "Standard NDA",
  "description": "Non-disclosure agreement for external partners.",
  "teamScope": ["team_hr"]
}

Response

{
  "success": true,
  "payload": {
    "templateId": "tpl_05xy..."
  }
}

After creation, add documents, configure recipients, and place fields before using the template to send envelopes.

Deleting a template

Deleting a template removes it and all its associated resources (documents, recipients, fields). Envelopes previously created from this template are not affected.

DELETE /api/v1/key/templates/{templateId}

Using a template

Once configured, a template is used via the jumpstart endpoint to create a ready-to-send envelope in a single request. See Start from a template.

Properties​

The teamScope field​

Templates vs. envelopes​

Creating a template​

Deleting a template​

Using a template​