Archive a template
Archives the template by setting its status to archived — a soft delete that keeps every published version intact and frees the slug for reuse by a new template.
Archives the template by setting its status to archived — a soft delete that keeps every published version intact and frees the slug for reuse by a new template. An archived template no longer appears in list or single-template reads (both return 404) and can no longer be sent by slug or current version; a send that pins an explicit version against it still resolves, so scheduled and campaign sends already in flight are not broken. Responds 204 with an empty body. Requires the templates:write scope.
Scope: templates:write. Send the API key as a bearer token; Scopes lists what each one reaches.
Request
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
idOrSlug | string | yes | Template UUID or slug. |
Response
200 Success. Body: application/json, TemplateDeleteResponse.
| Field | Type | Required | Description |
|---|---|---|---|
deleted | boolean | yes | |
id | string (uuid) | yes |
Errors
Every error has the same body, {"error": {"type", "code", "message", "param"}}; branch on code. Errors lists every code.
| Status | Meaning |
|---|---|
400 | The request is malformed or a value is invalid (invalid_request, invalid_domain, idempotency_key_mismatch). |
401 | The API key is missing or invalid. |
403 | The key lacks the scope this endpoint needs (scope_missing) or may not do this (not_permitted). |
404 | No such resource in this account (resource_not_found). |
422 | The request is well-formed but a field failed validation (validation_failed). |
429 | Rate limit, plan limit, budget or spend cap reached (rate_limited, plan_limit_reached, budget_exceeded, spend_cap_reached). |
500 | An unexpected error; retry with backoff, then contact support (internal_error). |