Sign in
latestOpenAPI 3.1.02026-08-20723176475.4 KB

c2b39b2c43c5

Projects

Update a project

Updates the details of a specific project by its ID within a given space.

put/v1/spaces/{spaceId}/projects/{projectId}

Path parameters

spaceIdinteger required

ID of the space

projectIdinteger required

ID of the project

Headers

X-Org-Idinteger required

Organization ID

Request body

namestring

Name of the project. Optional.

descriptionstring

Description of the project. Optional.

isPublicboolean

Indicates if the project is public. Optional.

startDatestring date-time

Start date of the project. Optional.

dueDatestring date-time

Due date of the project. Optional.

statusstring

Status of the project. Optional.

prioritystring

Priority of the project. Optional.

healthstring

Health of the project. Optional.

projectTagsstring[]

List of tags associated with the project. Optional.

contactinteger

Contact ID associated with the project. Optional.

actualStartDatestring date-time

Actual start date of the project. Optional.

actualEndDatestring date-time

Actual end date of the project. Optional.

allocatedBudgetnumber double

Budget allocated for the project. Optional.

billableCostnumber double

Billable cost of the project so far. Optional.

nonBillableCostnumber double

Non-billable cost of the project so far. Optional.

actualCostnumber double

Actual cost of the project (billable + non-billable). Optional.

projectTypestring

Commercial model of the project. One of FIXED_FEE, TIME_AND_MATERIAL, RETAINER. Optional.

contractValuenumber double

Contract value for Fixed Fee projects. Optional.

alertThresholdPercentinteger

Threshold percent (1..100) at which health flips to AT_RISK. Shared by Fixed Fee and Time & Material. Optional.

nteCapHoursinteger

Not-to-exceed cap in milliseconds for Time & Material projects. Optional.

retainerBudgetPeriodstring

Retainer budget period. One of MONTHLY, QUARTERLY, ANNUALLY. Optional.

retainerBudgetedHoursinteger

Per-cycle hour budget in milliseconds for Retainer projects. Optional.

retainerFeenumber double

Per-cycle retainer fee in USD (base currency). Optional.

retainerCountHoursModestring

Which time entries count toward the retainer hour bucket. One of BOTH, BILLABLE_ONLY, NON_BILLABLE_ONLY. Optional.

retainerCountCostModestring

Which time entries count toward the retainer cost total. One of BOTH, BILLABLE_ONLY, NON_BILLABLE_ONLY. Optional.

retainerCycleAnchorstring date

First day of the first retainer cycle in yyyy-MM-dd format. Optional.

Example request

{
  "name": "Project Beta",
  "description": "Updated description of the project",
  "startDate": "2023-02-01",
  "dueDate": "2023-11-30",
  "status": "Completed",
  "priority": "Medium",
  "health": "At Risk",
  "projectTags": [
    "tag3",
    "tag4"
  ],
  "contact": 67890,
  "actualStartDate": "2023-01-05",
  "actualEndDate": "2023-12-15",
  "allocatedBudget": 500000,
  "billableCost": 200000,
  "nonBillableCost": 50000,
  "actualCost": 250000,
  "projectType": "FIXED_FEE",
  "contractValue": 45000,
  "alertThresholdPercent": 80,
  "nteCapHours": 720000000,
  "retainerBudgetPeriod": "MONTHLY",
  "retainerBudgetedHours": 540000000,
  "retainerFee": 8000,
  "retainerCountHoursMode": "BOTH",
  "retainerCountCostMode": "BOTH",
  "retainerCycleAnchor": "2024-01-01"
}

Response

OK