v1

latestOpenAPI 3.1.0AGPL-3.0 license2026-07-1210336283.6 KB
Tracker Projects

Update a tracker project

Update a tracker project for the authenticated team.

patch/tracker-projects/{id}

Path parameters

idstring uuid required

Unique identifier of the project to retrieve

Example:b7e6c8e2-1f2a-4c3b-9e2d-1a2b3c4d5e6f

Unique identifier of the project to retrieve

Request body

namestring required

Name of the project

descriptionstring nullable

Detailed description of the project

estimatenumber nullable

Estimated total hours required to complete the project

billableboolean nullable

Whether the project is billable to the customer

ratenumber nullable

Hourly rate for the project in the specified currency

currencystring nullable

Currency code for the project rate in ISO 4217 format

status'in_progress' | 'completed'

Current status of the project

customerIdstring uuid nullable

Unique identifier of the customer associated with this project

Example request

{
  "name": "Website Redesign",
  "description": "Complete redesign of the company website with modern UI/UX and improved performance",
  "estimate": 120,
  "billable": true,
  "rate": 75,
  "currency": "USD",
  "status": "in_progress",
  "customerId": "a1b2c3d4-e5f6-7890-abcd-1234567890ef",
  "tags": [
    {
      "id": "f1e2d3c4-b5a6-7890-1234-567890abcdef",
      "value": "Design"
    },
    {
      "id": "e2d3c4b5-a6f1-7890-1234-567890abcdef",
      "value": "Frontend"
    }
  ]
}

Response

Tracker project updated successfully.

idstring uuid required

Unique identifier of the project

namestring required

Name of the project

descriptionstring nullable required

Detailed description of the project

status'in_progress' | 'completed' required

Current status of the project

estimatenumber nullable required

Estimated total hours required to complete the project

currencystring nullable required

Currency code for the project rate in ISO 4217 format

createdAtstring required

Date and time when the project was created in ISO 8601 format

totalDurationnumber nullable required

Total tracked time for the project in seconds

totalAmountnumber required

Total monetary amount earned from the project

Example response

{
  "id": "b7e6c8e2-1f2a-4c3b-9e2d-1a2b3c4d5e6f",
  "name": "Website Redesign",
  "description": "Complete redesign of the company website with modern UI/UX and improved performance",
  "status": "in_progress",
  "estimate": 120,
  "currency": "USD",
  "createdAt": "2024-05-01T12:00:00.000Z",
  "totalDuration": 43200,
  "totalAmount": 3600,
  "customer": {
    "id": "a1b2c3d4-e5f6-7890-abcd-1234567890ef",
    "name": "Acme Corporation",
    "website": "https://acme.com"
  },
  "tags": [
    {
      "id": "d1e2f3a4-b5c6-7890-abcd-1234567890ef",
      "name": "Design"
    }
  ],
  "users": [
    {
      "id": "f1e2d3c4-b5a6-7890-abcd-1234567890ef",
      "fullName": "Jane Doe",
      "avatarUrl": "https://cdn.midday.ai/avatar.jpg"
    }
  ]
}