---
title: "Rename a project or change its description"
method: PATCH
path: "/v1/projects/{id}"
tags: ["Projects"]
---

# Rename a project or change its description

`PATCH /v1/projects/{id}`

## Request

- Base URL: `https://console-api-sandbox.akash.network`
- URL: `https://console-api-sandbox.akash.network/v1/projects/{id}`
- Auth: one of:
  - HTTP bearer
  - API key in header `x-api-key`

## Path parameters

- `id` string, uuid, required

## Headers

- `x-organization-id` string
- `x-project-id` string, uuid

## Request body

- object
  - `data` object, required
    - `name` string: Unique within the organization, whatever its case.
    - `description` string, nullable

## Response `200`

The updated project

- object
  - `data` object, required
    - `id` string, uuid, required
    - `name` string, required
    - `slug` string, required: Set from the name when the project is created and kept through renames.
    - `description` string, nullable, required
    - `isDefault` boolean, required
    - `createdAt` string, date-time, required
    - `createdBy` object, nullable, required
      - `id` string, uuid, required
      - `username` string, nullable, required

## Other responses

- `400`: The id is not a uuid, or the name or description is not valid
- `401`: Unauthorized
- `403`: The caller's role in the active organization does not allow it
- `404`: No project with this id in the caller's reach
- `409`: Another project of the organization has this name (`project_name_taken`)

## Changes

- **2026-10-25** `045ec4086a98`: 2 breaking
  - added the pattern `^[^\u0000-\u0008\u000b\u000c\u000e-\u001f\u007f-\u009f\u061c\u200e\u200f\u202a-\u202e\u2066-\u2069]*$` to the request property `data/description`
  - added the pattern `^[^\u0000-\u001f\u007f-\u009f\u061c\u200e\u200f\u202a-\u202e\u2066-\u2069]*$` to the request property `data/name`
- **2026-10-15** `bb97e5bacb6f`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/akash-network/apis/akash-network-console-api/changes/v1/projects/:id/patch.md)

---

[API](https://skmtc.dev/akash-network/apis/akash-network-console-api.md) - [All operations](https://skmtc.dev/akash-network/apis/akash-network-console-api/llms.txt) - [OpenAPI document](https://skmtc.dev/akash-network/apis/akash-network-console-api/revisions/b959efa6d493?raw)