Archive contract template
Archives a published template, removing it from active use.
Archived templates cannot be used in new workflows.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Archives a contract template version, setting its status to archived and removing it from active use. Archived templates cannot be selected when building new contract flows. The endpoint returns the updated template version.
Authentication & access
- Requires a client API token:
Authorization: Bearer <token>. - The caller must hold the
contracts.templates.archivepermission and have the OWNER or OPERATIONS role. - The client must have contract signing enabled. If the feature is disabled the request returns
403.
Path parameters
template_version_id(string, required) — the template version to archive. It must belong to your client.
Behavior
- The template version's
statusis set toarchived. - Existing contract flows and contract requests that already reference this template version are not affected; archiving only prevents the template from being used in new contract flows.
- An archived template can later be restored to
draftvia the unarchive endpoint.
Response
200 — Returns the updated ContractTemplateVersionResponse with status set to archived, along with the template's id, name, external_id, file_type, source_file, roles, fields, detected_variables, and timestamps.
Error responses
| Status | When |
|---|---|
403 | Contract signing is disabled for the client |
404 | No template version with this template_version_id exists under your client |
Standard 401 (authentication), 403 (insufficient permission or role), and 429 (rate limit) responses apply to every endpoint and are documented in the Error reference.