---
title: "Archive a message template"
description: "Review a template and confirm that it should no longer be available for updates, previews, publication, or new sends."
canonical: "https://studio.inttegro.com/inttegro-mcp/workflows/message-templates/archive-a-message-template"
format: inttegro-machine-docs/v1
language: "Ruby"
sdk_version: "v10.0.0"
reader_profile: optional
reader_manifest: "https://studio.inttegro.com/machine/ruby/readers/index.json"
reader_identification: "Optional: declare your client only if known and your current-session capabilities; use reader_manifest for supplemental recommendations."
preamble_estimated_tokens: 669
model_token_report: "https://studio.inttegro.com/machine/token-report.json"
preamble_questions: 5
preamble_source: "general"
recommended_mcp_tools: ["get_message","get_message_template","archive_message_template"]
estimated_tokens: 1223
token_estimate_method: "utf8_bytes_divided_by_4"
---

## Machine preamble

**Summary:** Review a template and confirm that it should no longer be available for updates, previews, publication, or new sends. This Ruby representation uses the selected SDK's native names wherever Studio has a verified mapping.

### Five questions

#### Q1. When should the reader use Archive a message template?

Use this MCP document when an authenticated AI client needs governed Inttegro context, guidance, presentation, or operations.

#### Q2. What is authoritative on this page?

The documented MCP catalog defines available abilities and confirmation boundaries. For live state, the structured tool result is authoritative; presentation output is only a rendering of that result.

#### Q3. What page-specific constraint matters most?

Read operations do not authorize mutations. Actions retain their exact confirmation requirements, and payment credentials or OTP must stay in secure Checkout.

#### Q4. Can Inttegro MCP materially help with this task?

Yes, when the reader has an authenticated MCP connection and the task needs live context, guided planning, or a supported operation. The strongest matches are `get_message`, `get_message_template`, `archive_message_template`; their exact roles and boundaries are listed below.

#### Q5. How should the reader verify the answer and continue?

Preserve the structured tool result, distinguish bounded lists from complete analytics, and reconcile asynchronous actions through an authoritative read. Continue with [archive_message_template](https://studio.inttegro.com/machine/ruby/inttegro-mcp/tools.md#archive_message_template) and [get_message_template](https://studio.inttegro.com/machine/ruby/inttegro-mcp/tools.md#get_message_template) when those concerns enter scope.

### Recommended MCP assistance

Use these through an authenticated Inttegro MCP connection. This document remains the contract source.

- [`get_message`](https://studio.inttegro.com/machine/ruby/inttegro-mcp/tools.md#get_message) — read; no mutation confirmation. Gets the lifecycle status of one customer message without exposing its body or recipient contact details.
- [`get_message_template`](https://studio.inttegro.com/machine/ruby/inttegro-mcp/tools.md#get_message_template) — read; no mutation confirmation. Gets one template with editable channel content and version state while withholding variable defaults and private email-header values.
- [`archive_message_template`](https://studio.inttegro.com/machine/ruby/inttegro-mcp/tools.md#archive_message_template) — action; exact user confirmation required. Archives a template so it cannot be updated, published, previewed, or selected for new sends.

## Document content

# Archive a message template

Archive a template when it should no longer be used for new customer messages. This is a destructive lifecycle change and requires confirmation.

### Prompt

> **Copyable prompt:**
>
> Inspect message template `<MESSAGE_TEMPLATE_ID>` and prepare to archive it.
> Show its name, channel, purpose, status, published version, and whether it has
> unpublished changes. Explain what archival prevents, then ask for one final
> confirmation. Make no change if the template is already archived.

The agent inspects the current resource with [`get_message_template`](https://studio.inttegro.com/machine/ruby/inttegro-mcp/tools.md#get_message_template), then calls [`archive_message_template`](https://studio.inttegro.com/machine/ruby/inttegro-mcp/tools.md#archive_message_template) only after you approve the exact template and consequence.

## Sample response: Message template archived

The template is no longer available for updates, previews, publication, or new sends through MCP.

- **Template**: Holiday hours — tmpl\_example\_holiday
- **Channel**: SMS
- **Published version**: 2
- **Status**: Archived

Archiving a template does not retract messages that were already sent and does not delete their delivery records.