Archive contract template
Hides a template from the default template list and stops new contract
requests from being sent with it (or with any contract flow built on it).
Existing contract requests are untouched. Use this for a template that is
linked to sent contract requests and so cannot be deleted. Reversible with
unarchive. Returns 404 if the template does not exist.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Archive a contract template you no longer want to use. An archived template disappears from the default template list, and no new contract can be sent with it, either directly or through any contract flow built on it. Contracts already sent are not affected and keep working to the end.
Use this for a template that has been used by a sent contract and therefore cannot be deleted. It is reversible with Unarchive Contract Template.
Authentication & access
- Requires a client API token:
Authorization: Bearer <token>. - API credentials need the
contracts.templates.archivepermission. Dashboard users need the OWNER or OPERATIONS role, or a custom role that includes this permission. - Contract signing must be enabled for the client. If it is disabled the request returns
403.
Path parameters
| Parameter | Description |
|---|---|
template_version_id | ID of the template to archive. Must belong to your client. |
Behavior
- The template
statusbecomesarchived. Archiving an already archived template succeeds and changes nothing. GET /api/v1/contracts/templatesonly returns it withinclude_archived=trueorstatus=archived.- Sending with it, or with a contract flow that uses it, returns
400until it is unarchived.
Response
200 - The updated template, with status set to archived.
Error responses
| Status | When |
|---|---|
403 | Contract signing is disabled for the client |
404 | No template 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.