v2

latestSwagger 2.02026-08-04108164321.0 KB
Project

Updates 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.

put/api/Project

Request body

ProjectIDinteger

The ID of the Project to update

FieldsToUpdatestring[]

A string array of field names to be updated. Only listed fields will be modified.

ProjectTitlestring

(optional) An updated project title. (255 characters max)

ProjectNotesstring

(optional) Any descriptive notes about the project. (2000 characters max)

TimesheetApprovalRequiredbyDefaultboolean

Whether timesheet approval should be required by default for newly added project members.

isTaskRequiredOnTimesheetboolean

Whether timesheets entered against this project require a task to be selected.

StartDatestring date-time

Planned start date for the project.

EndDatestring date-time

Planned end date for the project.

BudgetAmountnumber double

Monetary budget allocated to the project.

BudgetHoursnumber double

Hours budget allocated to the project.

ProjectStatusCodestring

Update the project status (string, optional): (Possible values: NotStarted, InProgress, Complete, OnHold)

ProjectCategoryIDFKinteger

The project category ID, if categorised.

ProjectBillableTypeCodestring

The billing method of the project. (string, optional) Possible values: CategoryHourly, NoRate, NotBillable, PersonHourly, ProjectHourly

ProjectBudgetTypeCodestring

The project budgeting type. (string, optional) Possible values: NoBudget, PersonHours, ProjectFees, ProjectHours, CategoryHours

ScheduleRateUpdateOptionstring

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.

TimesheetRateUpdateOptionstring

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.

SendWebhooksboolean

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.

ProjectIDinteger

Unique identifier for the project.

Titlestring

Project title/name.

ProjectCodestring

Short reference code for the project.

Notesstring

Project description or notes.

CompanyNamestring

Name of the customer company this project belongs to.

CompanyIDFKinteger

The customer company ID this project is linked to.

ProjectOwnerUserIDFKinteger

User ID of the project owner/manager.

ProjectStatusCodestring

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.

ProjectStatusNamestring

Display name of the project status (e.g. "In Progress", "At Risk").

ProjectStatusColorstring

Hex colour assigned to the project status (e.g. "#F0AD4E").

ProjectStatusIsNotStartedboolean

True if this is the account's default-for-new-projects status (one row per account).

ProjectStatusIsCompleteboolean

True if this status marks the project as complete (one row per account).

isArchivedboolean

Whether the project is archived. Archived projects are hidden from default views.

ProjectBillableTypeCodestring

Possible values: CategoryHourly, NoRate, NotBillable, PersonHourly, ProjectHourly

ProjectBudgetTypeCodestring

Possible Values: CategoryHours, NoBudget, PersonHours, ProjectFees, ProjectHours

BudgetAmountnumber double

Monetary budget allocated to the project.

BudgetHoursnumber double

Hours budget allocated to the project.

ProjectHourlyRatenumber double

The project-level hourly rate (when billing type is ProjectHourly).

ProjectCategoryIDFKinteger

The project category ID, if categorised.

ProjectCategoryNamestring

Name of the project category.

isTaskRequiredOnTimesheetboolean

Whether users must select a task when logging time to this project.

DefaultAccountTaskTypeIDFKinteger

The default task type ID used for new tasks in this project.

DefaultAccountTaskTypeNamestring

Name of the default task type.

ProjectCategoryColorstring

Html Hex Color Code starting with #

StartDatestring date-time

Planned start date for the project.

EndDatestring date-time

Planned end date for the project.

DateCreatedstring date-time

Date the project was created.

DateUpdatedstring date-time

Date the project was last updated.

ViewProjectURLstring

URL to view this project in the Avaza web application.