---
search:
  tags:
    - Modules
    - PATCH
seo:
  description: >-
    Archive or unarchive a module. Pass operation: archive or unarchive. Returns
    the… Reference for the PATCH /modules/{id}/archive endpoint in the Fuxam API
    v4.
sidebar:
  label: Archive or unarchive a module
  badge: PATCH
title: Archive or unarchive a module
type: openapi-operation
---
Archive or unarchive a module. Pass `operation`: `archive` or `unarchive`. Returns the updated module row. Scoped to your integration's institution via Basic Auth credentials.

`PATCH /modules/{id}/archive`

**Request body** (`application/json`, required)

- `operation` (string, required)

Request body example:

```json
{
  "operation": "archive"
}
```

**Responses**

- `200` — Module archived/unarchived
- `401` — Unauthorized
- `404` — Not Found
- `429` — Too Many Requests — 1000 requests per minute per institution. Includes \`X-RateLimit-Limit\`, \`X-RateLimit-Remaining\`, \`X-RateLimit-Reset\` (ISO-8601), and \`Retry-After\` (seconds).
- `500` — Internal Server Error

Response example, 200:

```json
{
  "data": {
    "id": "cm_xyz789",
    "name": "Economics",
    "institutionId": "inst_123",
    "code": "ECO-101",
    "isArchived": true,
    "nameTranslations": null,
    "isSubmodule": false
  },
  "meta": {
    "requestId": "req_abc123",
    "timestamp": "2026-06-26T00:00:00.000Z",
    "version": "v4"
  }
}
```
