---
title: "File a project away, or bring it back"
method: POST
path: "/projects/{id}/archive"
tags: ["Projects"]
---

# File a project away, or bring it back

`POST /projects/{id}/archive`

## Request

- Base URL: `https://api.epovest.com/v1`
- URL: `https://api.epovest.com/v1/projects/{id}/archive`
- Auth: HTTP bearer

The body is the STATE you want: omitted it files the project away, `{"archived": false}`
brings it back, and both moves answer the same when replayed. Nothing cascades: the trackers
filed under it keep their status and keep measuring, and the answer carries `tracker_count`,
how many are still filed under it. Manager or above.

## Request body

- ArchiveState: The STATE you want. Omitted, it files away; both moves answer the same when replayed.
  - `archived` boolean

## Response `200`

The project, filed away or back in use.

- ProjectEnvelope
  - `project` Project, required
    - `id` string, uuid, required
    - `name` string, required
    - `canon` Canon, required: The brand identity sheet: the text every publication reuses as is, so all mentions tell the same entity. It lives in ONE language per project, its canonical language, and the facts are language-NEUTRAL and identical everywhere.
      - `one_liner` string, nullable, required
      - `short` string, nullable, required
      - `long` string, nullable, required
      - `category` string, nullable, required
      - `language` string, nullable, required: The canonical language, a short code like `en` or `pt-br`. Null when never declared.
      - `perks` string[], required: The ordered list of distinctive claims, written in the canonical language, meant to be hammered so the engines bring them up on their own: facts that hold and can be corroborated.
      - `website` string, nullable, required: The canonical address that identifies the entity, ONE URL only. A bare domain completes to https, and a trailing slash is dropped.
      - `legal_name` string, nullable, required: The registered name of the company that operates the brand, with its jurisdiction when it is stated: the name the AIs cross-read to anchor the entity.
      - `address` string, nullable, required
      - `phone` string, nullable, required
      - `whatsapp` string, nullable, required
      - `email` string, nullable, required
    - `canon_version` integer, nullable, required
    - `link_targets` string[], required: The free addresses of the brand set on the project, the ones read by `GET /projects/{id}/link-targets`.
    - `archived` boolean, required
    - `tracker_count` integer, required: How many trackers are still filed under it.
    - `created_at` string, date-time, required

## Other responses

- `401`: `unauthenticated`: missing, unknown or revoked key.
- `403`: `insufficient_scope`: the credential may not do this, either because the key lacks the scope, or, on a one-click connection, because the person lacks the role the action needs (manager, or owner to start, pause and top up). On that path, read it as "this person may not do this" and tell them which role the action needs.
- `404`: `not_found`: unknown for this account.
- `422`: `invalid_project`: `archived` must be a boolean.
- `429`: `rate_limited`: 120 requests per minute per credential, sliding window. Retry after `Retry-After` seconds.

---

[API](https://skmtc.dev/epovest/apis/epovest-api.md) · [All operations](https://skmtc.dev/epovest/apis/epovest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/epovest/apis/epovest-api/revisions/7a78ee27ecbb?raw)