---
title: "Archive macros"
method: PUT
path: "/api/macros/archive"
tags: ["Macros"]
---

# Archive macros

`PUT /api/macros/archive`

## Request body

- ArchiveMacrosAsUser
  - `ids` integer[], required — List of macro ids to be archived

## Response `207`

Partial success archive operation.

- ArchiveMacrosAsUserResult
  - `data` ArchiveMacroAsUserResult[], required
    - `id` integer, required
    - `status` 'archived' | 'not_found' | 'already_archived' | 'macro_used', required
    - `error` MacroUsageError
      - `data` MacroUsageErrorData, required
        - `rules` string[], required
      - `msg` string, required

---

[API](https://skmtc.net/gorgias/apis/gorgias-rest-api.md) · [All operations](https://skmtc.net/gorgias/apis/gorgias-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gorgias/gorgias-rest-api/revisions/36f2e31f4e81/schema)
