v2
latestSwagger 2.02026-08-04108164321.0 KBUpdates an existing project. Only fields listed in the FieldsToUpdate array will be modified. When ProjectBillableTypeCode is updated, use ScheduleRateUpdateOption and TimesheetRateUpdateOption to control whether rate changes cascade to existing schedule bookings and timesheet entries respectively.
Request body
The ID of the Project to update
A string array of field names to be updated. Only listed fields will be modified.
(optional) An updated project title. (255 characters max)
(optional) Any descriptive notes about the project. (2000 characters max)
Whether timesheet approval should be required by default for newly added project members.
Whether timesheets entered against this project require a task to be selected.
Planned start date for the project.
Planned end date for the project.
Monetary budget allocated to the project.
Hours budget allocated to the project.
Update the project status (string, optional): (Possible values: NotStarted, InProgress, Complete, OnHold)
The project category ID, if categorised.
The billing method of the project. (string, optional) Possible values: CategoryHourly, NoRate, NotBillable, PersonHourly, ProjectHourly
The project budgeting type. (string, optional) Possible values: NoBudget, PersonHours, ProjectFees, ProjectHours, CategoryHours
Controls whether updated rates are applied to existing schedule bookings when ProjectBillableTypeCode changes. Possible values: "new" (default, only new bookings), "all" (all existing bookings), "active" (bookings with end date in the future). Only applies when ProjectBillableTypeCode is included in FieldsToUpdate.
Controls whether updated rates are applied to existing timesheet entries when ProjectBillableTypeCode changes. Possible values: "new" (do not update existing timesheets), "uninvoiced" (update all existing uninvoiced timesheets). Defaults to "uninvoiced" if not specified, to preserve backwards compatibility. Only applies when ProjectBillableTypeCode is included in FieldsToUpdate.
If true, fires the project_updated webhook event to any subscribed endpoints. Defaults to false to preserve existing integration behaviour.
Response
Returns the updated project details.
Unique identifier for the project.
Project title/name.
Short reference code for the project.
Project description or notes.
Name of the customer company this project belongs to.
The customer company ID this project is linked to.
User ID of the project owner/manager.
Project status code. Per-account configurable. Default codes (NotStarted, InProgress, Complete, OnHold) are seeded for every account; admins may add custom codes via the Project Statuses settings panel. Codes are unique within an account and stable once created.
Display name of the project status (e.g. "In Progress", "At Risk").
Hex colour assigned to the project status (e.g. "#F0AD4E").
True if this is the account's default-for-new-projects status (one row per account).
True if this status marks the project as complete (one row per account).
Whether the project is archived. Archived projects are hidden from default views.
Possible values: CategoryHourly, NoRate, NotBillable, PersonHourly, ProjectHourly
Possible Values: CategoryHours, NoBudget, PersonHours, ProjectFees, ProjectHours
Monetary budget allocated to the project.
Hours budget allocated to the project.
The project-level hourly rate (when billing type is ProjectHourly).
The project category ID, if categorised.
Name of the project category.
Whether users must select a task when logging time to this project.
The default task type ID used for new tasks in this project.
Name of the default task type.
Html Hex Color Code starting with #
Planned start date for the project.
Planned end date for the project.
Date the project was created.
Date the project was last updated.
URL to view this project in the Avaza web application.