---
title: "Edit an epic"
method: PATCH
path: "/projects/{project}/epics/{epic}"
tags: ["Planning"]
---

# Edit an epic

`PATCH /projects/{project}/epics/{epic}`

## Request

- Base URL: `https://api.yokka.ai/api/v1`
- URL: `https://api.yokka.ai/api/v1/projects/{project}/epics/{epic}`
- Auth: HTTP bearer

Rename an epic, rewrite its brief, or close it when its work has shipped (closed epics keep their cards but take no new ones). closed: false reopens it.

Needs a read-and-write token. Same as the MCP tool `update_epic`.

## Path parameters

- `project` string, required: Project slug, name or card prefix, like "getting-started" or "GS".
- `epic` string, required: Epic name, like "Checkout v2".

## Headers

- `X-Client-Name` string

## Request body

- object
  - `name` string: New name.
  - `brief` string: New brief (markdown).
  - `closed` boolean: true closes the epic, false reopens it.

## Response `200`

The tool's result.

- object
  - `epic` string, required
  - `closed` boolean, required

## Other responses

- `400`: The arguments aren't valid, or the change isn't possible as asked.
- `401`: The token is missing, invalid, revoked or expired.
- `403`: The token can't do this, or a plan or board limit was reached.
- `404`: Something it names wasn't found, or isn't visible to this token.
- `413`: The request body is too large.
- `429`: Too many calls: retry after `Retry-After` seconds.

---

[API](https://skmtc.dev/yokka/apis/yokka-rest-api.md) · [All operations](https://skmtc.dev/yokka/apis/yokka-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/yokka/apis/yokka-rest-api/revisions/19083353485e?raw)
