Archive Contract Template

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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.archive permission. 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

ParameterDescription
template_version_idID of the template to archive. Must belong to your client.

Behavior

  • The template status becomes archived. Archiving an already archived template succeeds and changes nothing.
  • GET /api/v1/contracts/templates only returns it with include_archived=true or status=archived.
  • Sending with it, or with a contract flow that uses it, returns 400 until it is unarchived.

Response

200 - The updated template, with status set to archived.

Error responses

StatusWhen
403Contract signing is disabled for the client
404No 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.

Path Params
string
required
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json