Archive a Forward template.
POST /api/v1/forward/templates/{template_id}/archive
Archives a template without deleting historical records.
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT or SAT> |
Idempotency-Key | No | Optional idempotency key for unsafe requests. |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
template_id | string | Yes | Forward Template ID. |
Example request
Example response
HTTP 200 OK
Response fields
Returns the archived Template object with status set to archived.
Errors
| HTTP | Type | Trigger |
|---|---|---|
| 401 | authentication_error | PAT or SAT invalid or expired. |
| 404 | not_found_error | Template does not exist or is not visible to the caller. |
| 409 | conflict_error | Template state does not allow archive. |
| 401 | authentication_error | authentication_required |
Notes
- Archive is a soft lifecycle state.
- Archived templates are excluded from list results unless requested by status.