Tasks

Update a task

patch/tasks/{id}

Request

  • Base URL: https://www.ruddr.io/api/workspace
  • URL: https://www.ruddr.io/api/workspace/tasks/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The task uuid.

Request body

namestring

The name of the task (max 255 chars).

notesstring nullable

Any notes associated with the task (max 5000 chars).

statusId'not_started' | 'in_progress' | 'completed'

The status of the task, defaults to not_started if not set.

startstring date nullable

The start date (YYYY-MM-DD) of the task, must come on or before end date if set.

endstring date nullable

The end date (YYYY-MM-DD) of the task, must come on or after the start date if set.

isBillableboolean

Whether the task is billable, defaults to true if not set. Will be overridden to false if the project is not billable.

lockTimeboolean

When enabled, prevents new time entries from being created with this task.

capHoursboolean

When enabled, prevents time entries that would exceed the budgeted hours for this task.

capAssignedHoursboolean

When enabled, prevents time entries that would exceed the budgeted hours assigned to the role or member for this task.

codestring nullable

The task code (max 255 chars).

forAssignedOnlyboolean

When enabled, only assigned members and roles can track time to this task.

requireNotesboolean

Requires notes on time entries for this task.

budgetedHoursnumber nullable

The budgeted hours for the task. Only used if there are no roles or project members set.

budgetedServicesRevenuenumber nullable

The budgeted services revenue for the task. Only used if there are no roles or project members set.

tagIdsstring[]

A list of task tag IDs (uuid) to associate with this task.

predecessorIdsstring[]

A list of task IDs (uuid) that must finish before this task can start. Requires useDependencies to be enabled on the project. The referenced tasks must belong to the same project.

successorIdsstring[]

A list of task IDs (uuid) that cannot start until this task finishes. Requires useDependencies to be enabled on the project. The referenced tasks must belong to the same project.

taskCategoryIdstring

The ID (uuid) of the task category to assign to this task.

parentIdstring nullable

The ID (uuid) of the parent task to nest this task under.

recordStatusId'active' | 'archived'

The record status of the task, defaults to active if not set.

Response

200

idstring

The unique identifier for the object.

namestring

The name of the task.

notesstring nullable

Any notes associated with the task.

orderinteger

The display order position of the task (same value as position).

positioninteger

The numeric position of the task used for ordering.

statusId'not_started' | 'in_progress' | 'completed'

The status of the task.

startstring date nullable

The start date for the task. Will be in the form YYYY-MM-DD.

endstring date nullable

The end date for the task. Will be in the form YYYY-MM-DD. null if no end date is set.

isBillableboolean

Whether the task is billable. Overridden to false when the project is not billable.

lockTimeboolean

When enabled, prevents new time entries from being created with this task.

capHoursboolean

When enabled, prevents time entries that would exceed the budgeted hours for this task.

capAssignedHoursboolean

When enabled, prevents time entries that would exceed the budgeted hours assigned to the role or member for this task.

codestring nullable

The task code.

forAssignedOnlyboolean

When enabled, only assigned members and roles can track time to this task.

requireNotesboolean

Whether notes are required on time entries for this task. Overridden to true when the project requires notes.

recordStatusId'active' | 'archived'

The record status of the task.

budgetedHoursnumber nullable

The budgeted hours for the task.

budgetedServicesRevenuenumber nullable

The budgeted services revenue for the task.

createdAtstring date-time

The timestamp when the object was created.

modifiedAtstring date-time

The timestamp when the object was last modified.

Changes

No recorded changes to this operation across all 1 revision of this API.