v1

latestSwagger 2.02026-07-13107162315.5 KB
Task

Update a Task.

Requires TaskID and a list of field names to update. The FieldsToUpdate field accepts a string array containing field names that should be updated.

put/api/Task

Request body

TaskIDinteger required

Unique identifier for the task.

FieldsToUpdatestring[] required

Array of field names to update. Only listed fields will be modified.

SectionIDFKinteger

The section (task group) this task belongs to.

Titlestring

Task title/name.

Descriptionstring

Task description (may contain HTML).

AssignedToUserIDFKinteger[]

List of user IDs to assign to this task.

DateStartstring date-time

Task start date.

DateDuestring date-time

Task due date.

TaskPriorityCodestring

Task priority. Values: None, Low, Medium, High, Urgent.

EstimatedEffortnumber double

Decimal hours

TaskStatusCodestring

Current task status code.

PercentCompleteinteger

Task completion percentage (0-100).

FileAttachmentIDsToAddinteger[]

FileAttachmentIDs (returned from prior /api/FileAttachment uploads) to newly link to this task. Each ID must have been created by the current user and not yet linked to any entity.

SendWebhooksboolean

If true, fires the matching webhook event (e.g. task_updated) to any subscribed endpoints. Defaults to false to preserve existing integration behaviour.

Response

Returns the updated task details.

TaskIDinteger

Unique identifier for the task.

ProjectIDFKinteger

The project this task belongs to.

ProjectTitlestring

Title of the parent project.

ProjectCodestring

Short code of the parent project.

SectionTitlestring

Title of the section this task is in.

SectionIDFKinteger

The section (task group) this task belongs to.

Titlestring

Task title/name.

Descriptionstring

Task description (may contain HTML).

DescriptionNoHTMLstring

Task description with HTML tags stripped.

DateStartstring date-time

Task start date.

DateDuestring date-time

Task due date.

DateCompletedstring date-time

Date the task was marked as completed.

EstimatedEffortnumber double

Estimated effort in decimal hours.

ActualTimenumber double

Actual time logged against this task in decimal hours.

AccountTaskTypeIDFKinteger

The task type (workflow) ID for this task.

TaskStatusCodestring

Current task status code.

TaskStatusNamestring

Display name of the current task status.

isCompleteStatusboolean

Whether the current status represents a completed state.

PercentCompletenumber double

Task completion percentage (0-100).

TaskPriorityCodestring

Task priority. Values: None, Low, Medium, High, Urgent.

TaskPriorityNamestring

Display name of the task priority.

ViewTaskURLstring

URL to view this task in the Avaza web application.

DateCreatedstring date-time

Date and time the task was created.

DateUpdatedstring date-time

Date and time the task was last updated.

ParentTaskIDFKinteger

Parent task ID if this is a subtask. NULL for root-level tasks.

ParentTaskTitlestring

Title of the parent task (denormalized for display). NULL for root-level tasks.

SubtaskCountinteger

Number of immediate subtasks under this task.

SubtaskProgressinteger

Percentage of subtasks in a complete status (0-100).