Outcome
Archive an email template so it can no longer be edited or chosen for new email. Its versions are kept for history.
Before you start
- Verify identity and pin the intended organization and environment before discovering the action.
- Discover a granted Nurture workspace. The application permission is workspace:write; required workspace access is read_write. A permission alone does not supply a workspace grant.
- Organization and workspace come from verified context. Select resourceType/resourceId separately from action input; body fields cannot grant a different organization or workspace. The first authorized product action can initialize an identity-only workspace mirror.
- Obtain authorization for the documented effect or personal-data export before supplying CLI --confirm or MCP confirm:true.
Discover the target
topolo whoami --json
topolo actions get app_topolo_nurture.templates.archive --detail --json
topolo resources topolo-nurture --json
topolo workspaces list topolo-nurture --json
topolo actions get app_topolo_nurture.templates.list --detail --json
id: templates record id in the selected workspace.
Request
POST /api/templates/{id}/archive
Save action input as payload.json. The reviewed plan separates path identifiers, query fields and HTTP body. Set NURTURE_WORKSPACE_ID from granted resource discovery; it is separate from action input.
Inspect and test this action in the signed action console. A test response still requires the verification below.
Input fields
| Field | Required | Type | Constraints |
|---|---|---|---|
id | Required | string | templates record id in the selected workspace. {"minLength":1,"maxLength":64} |
Exact input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
},
"required": [
"id"
],
"additionalProperties": false
}
Effects
- Sets the template status to archived; nothing is deleted.
Interpret the response
The returned identifier path is $.template.id for template. Empty lists do not discover a target.
Call app_topolo_nurture.templates.get and confirm status is archived.
Exact success schema:
{
"type": "object",
"required": [
"template"
],
"properties": {
"template": {
"type": "object",
"required": [
"id",
"subject",
"blocks",
"version",
"currentVersion"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"subject": {
"type": "string"
},
"preheader": {
"type": "string"
},
"blocks": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"kind"
]
}
},
"status": {
"type": "string",
"enum": [
"active",
"archived"
]
},
"version": {
"type": "integer"
},
"currentVersion": {
"type": "integer"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
}
}
}
}
Worked examples
Actual dispatcher and migration-created SQLite or Worker handlers; identity/workspace and external service dependencies are simulated. Fixture identifiers and timestamps are synthetic. These responses establish no live authorization, paid generation, credential provisioning or message delivery. Replace synthetic identifiers using credential-scoped discovery. A local success is not evidence of a deployed effect, configured provider or delivered message.
Successful request
Actual dispatcher and migration-created SQLite; verified identity/workspace and external CRM, Engage, Notify, Consent, Nexus, Brand, Generator, Voice and delivery dependencies are simulated. No live authorization, paid generation or external delivery is established.
Input · payload.json:
{
"id": "tpl_3990808672244b54a01bf845ca7de098"
}
CLI:
topolo actions validate app_topolo_nurture.templates.archive --data @payload.json --json
topolo actions plan app_topolo_nurture.templates.archive --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.templates.archive --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --confirm --json
MCP tool and arguments:
{
"tool": "topolo_call_action",
"arguments": {
"actionId": "app_topolo_nurture.templates.archive",
"input": {
"id": "tpl_3990808672244b54a01bf845ca7de098"
},
"resourceType": "workspace",
"resourceId": "<identifier returned by resource discovery>",
"confirm": true
}
}
Captured local response · HTTP 200:
{
"template": {
"id": "tpl_3990808672244b54a01bf845ca7de098",
"name": "News",
"status": "archived",
"version": 1,
"currentVersion": 1,
"subject": "Hello {{contact.firstName|there}}",
"blocks": [
{
"id": "title",
"kind": "heading",
"text": "Hello {{contact.firstName|there}}",
"level": 1
},
{
"id": "footer",
"kind": "footer"
}
],
"createdAt": "2026-10-04T00:32:37.655Z",
"updatedAt": "2026-10-04T00:32:37.661Z"
}
}
HTTP 200. Call app_topolo_nurture.templates.get and confirm status is archived.
Another supported request
Actual dispatcher and migration-created SQLite; verified identity/workspace and external CRM, Engage, Notify, Consent, Nexus, Brand, Generator, Voice and delivery dependencies are simulated. No live authorization, paid generation or external delivery is established.
Input · payload.json:
{
"id": "tpl_0964c19bcf2c4ecd8e6bd10fad5eea14"
}
CLI:
topolo actions validate app_topolo_nurture.templates.archive --data @payload.json --json
topolo actions plan app_topolo_nurture.templates.archive --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.templates.archive --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --confirm --json
MCP tool and arguments:
{
"tool": "topolo_call_action",
"arguments": {
"actionId": "app_topolo_nurture.templates.archive",
"input": {
"id": "tpl_0964c19bcf2c4ecd8e6bd10fad5eea14"
},
"resourceType": "workspace",
"resourceId": "<identifier returned by resource discovery>",
"confirm": true
}
}
Captured local response · HTTP 200:
{
"template": {
"id": "tpl_0964c19bcf2c4ecd8e6bd10fad5eea14",
"name": "News",
"status": "archived",
"version": 1,
"currentVersion": 1,
"subject": "Hello {{contact.firstName|there}}",
"blocks": [
{
"id": "title",
"kind": "heading",
"text": "Hello {{contact.firstName|there}}",
"level": 1
},
{
"id": "footer",
"kind": "footer"
}
],
"createdAt": "2026-10-04T00:32:34.847Z",
"updatedAt": "2026-10-04T00:32:34.858Z"
}
}
HTTP 200. Call app_topolo_nurture.templates.get and confirm status is archived.
Refused request · permission_denied
Actual dispatcher and migration-created SQLite; verified identity/workspace and external CRM, Engage, Notify, Consent, Nexus, Brand, Generator, Voice and delivery dependencies are simulated. No live authorization, paid generation or external delivery is established.
Input · payload.json:
{
"id": "tpl_5e31c11f18e8412885cb4ad6dac80e10"
}
CLI:
topolo actions validate app_topolo_nurture.templates.archive --data @payload.json --json
topolo actions plan app_topolo_nurture.templates.archive --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
Captured local response · HTTP 403:
{
"error": {
"code": "permission_denied",
"message": "The credential lacks workspace:write."
}
}
HTTP 403. Preserve the refusal details and do not claim success.
Refused request · not_found
Actual dispatcher and migration-created SQLite; verified identity/workspace and external CRM, Engage, Notify, Consent, Nexus, Brand, Generator, Voice and delivery dependencies are simulated. No live authorization, paid generation or external delivery is established.
Input · payload.json:
{
"id": "tpl_missing"
}
CLI:
topolo actions validate app_topolo_nurture.templates.archive --data @payload.json --json
topolo actions plan app_topolo_nurture.templates.archive --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
Captured local response · HTTP 404:
{
"error": {
"code": "not_found",
"message": "Template was not found in this workspace."
}
}
HTTP 404. Preserve the refusal details and do not claim success.
Verify the result
- Call app_topolo_nurture.templates.get and confirm status is archived.
Errors and recovery
organization_required(HTTP 403): Select an organization available to the verified caller before choosing a Nurture workspace.permission_denied(HTTP 403): Grant the credential the required Nurture workspace permission.workspace_required(HTTP 409): Create a Nurture workspace, or pass the workspace resource context.invalid_input(HTTP 422): Correct the fields named in error.details using inputSchema, then retry.not_found(HTTP 404): List templates to find a valid id in this workspace.
Auth or gateway failures may precede this handler. Preserve the exact response shape, error string/code, request id and credential context; no synthetic fixture establishes live credential access.
Recovery boundary
Archiving cannot be undone; app_topolo_nurture.templates.duplicate makes an editable copy.
Related actions
- List email templates: List the email templates in the caller's Nurture workspace with their current subject and version, optionally filtered by status.
- Duplicate email template: Copy a template's current version into a new active template (version 1). Works on archived templates too. The name defaults to "<name> (copy)".
Evidence
Actual dispatcher and migration-created SQLite or Worker handlers; identity/workspace and external service dependencies are simulated. Fixture identifiers and timestamps are synthetic. These responses establish no live authorization, paid generation, credential provisioning or message delivery. Test scenario and capture digests are retained with each fixture.