Projects

Update project

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

patch/v1/projects/{projectId}

Request

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

Request body

namestring

The new name for the project.

status'active' | 'archived'

The project's current status (e.g., used for archiving).

Example request

{
  "name": "Landing Page Redesign v2",
  "status": "archived"
}

Response

Project successfully updated.

idstring
namestring
status'active' | 'archived'
team_idstring
created_atstring date-time
updated_atstring date-time
is_widget_installedboolean

Example response

{
  "id": "ab12cd34ef56gh78ij90klmn",
  "name": "Landing Page Redesign",
  "status": "active",
  "team_id": "4a9d7b2c01e3f5g8h2j4k6l9",
  "created_at": "2025-10-20T08:00:00.000Z",
  "updated_at": "2025-11-04T12:05:30.000Z",
  "is_widget_installed": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.