---
title: "Update project"
method: PATCH
path: "/v1/projects/{projectId}"
tags: ["Projects"]
---

# Update project

`PATCH /v1/projects/{projectId}`

## Request

- Base URL: `https://api.ybug.io`
- URL: `https://api.ybug.io/v1/projects/{projectId}`
- Auth: HTTP bearer

Updates editable fields on the project, such as the name or archived status. Send only the attributes that should change.

## Request body

- object
  - `name` string: The new name for the project.
  - `status` 'active' | 'archived': The project's current status (e.g., used for archiving).

## Response `200`

Project successfully updated.

- Project
  - `id` string
  - `name` string
  - `status` 'active' | 'archived'
  - `team_id` string
  - `created_at` string, date-time
  - `updated_at` string, date-time
  - `is_widget_installed` boolean

## Other responses

- `400`: Bad Request. The request was invalid (e.g., missing required fields in payload).
- `401`: Unauthorized. Missing or invalid API token.
- `403`: Forbidden. The user does not have permission to access the resource, or the operation is restricted by the account plan.
- `404`: Not Found. The requested resource (team or project ID) could not be found.
- `429`: Too Many Requests. The rate limit for the client has been exceeded.
- `500`: Internal Server Error. An unexpected error occurred on the server.

---

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