Skip to main content
DELETE
Archives one template of this instance’s terms library. Nothing is deleted: the template, its text and every version stay readable through Get Terms Template, and List Terms Templates lists it with includeArchived=true. An archived template can no longer be bound to a market or a standing policy. Restore it with archived: false on Update Terms Template. The call is the same as Update Terms Template with archived: true. It writes no new version, so changed is false. Archiving a template that is already archived changes nothing. Only an account Trusset approved as a lender of record can author templates. Any other account is refused with 403 CURATOR_NOT_APPROVED.

When archiving is refused

A template that is still in use cannot be archived, because the markets and policies bound to it would point at terms the library no longer lists, and a market adopted under such a policy would go live without terms of use. Archiving is refused with 409 TEMPLATE_IN_USE while the template is bound to either of these:
  • a market whose terms are published and not customised
  • any standing policy, switched off or not
error.details names every one of them: Release them first, then archive again:
  • Bind each market to another template with Save Terms and templateId, or customise its terms with a save that changes the text.
  • Bind each policy to another template, or to none with termsTemplateId: null, on Update Standing Policy.

Path Parameters

string
required
Template ID from List Terms Templates, 1 to 100 characters.

Response Fields

object

Error Codes