INinvoiceninja
tasks

Update task

Changed on

Handles the updating of a task by id

put/api/v1/tasks/{id}

Request

Path parameters

idstring string required

The task Hashed ID

Query parameters

includestring
Example:first_load

Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes

Headers

X-API-TOKENstring required
Example:TOKEN

The API token to be used for authentication

X-Requested-Withstring required
Example:XMLHttpRequest

Used to send the XMLHttpRequest header

Request body

descriptionstring required

Task description

client_idstring

The hashed ID of the client

project_idstring

The hashed ID of the project

time_logstring

Time logged for the task

status_idinteger

Status ID of the task

custom_value1string

Custom field value 1

custom_value2string

Custom field value 2

custom_value3string

Custom field value 3

custom_value4string

Custom field value 4

is_deletedboolean

Whether the task is deleted

archived_atinteger

Timestamp when task was archived

due_datestring date

Due date for the task

priorityinteger

Priority level of the task

tagsstring[]

Full sync array of hashed tag IDs. Omit to leave existing tags unchanged; send [] to detach all tags.

Example request

{
  "description": "Complete project documentation",
  "client_id": "D2J234DFA",
  "project_id": "P2J234DFA",
  "time_log": "2.5",
  "status_id": 1,
  "custom_value1": "Custom value 1",
  "custom_value2": "Custom value 2",
  "custom_value3": "Custom value 3",
  "custom_value4": "Custom value 4",
  "archived_at": 1640995200,
  "due_date": "2024-01-31",
  "priority": 1,
  "tags": [
    "Opnel5aKBz"
  ]
}

Response

Returns the task object

idstring

The hashed id of the task

user_idstring

The hashed id of the user who created the task

assigned_user_idstring

The assigned user of the task

client_idstring

The hashed if of the client

invoice_idstring

The hashed id of the invoice associated with the task

project_idstring

The hashed id of the project associated with the task

numberstring

The number of the task

time_logstring

An array of unix time stamps defining the start and end times of the task

is_runningboolean

Determines if the task is still running

is_deletedboolean

Boolean flag determining if the task has been deleted

task_status_idstring

The hashed id of the task status

descriptionstring

The task description

durationinteger

The task duration in seconds

task_status_orderinteger

The order of the task

ratenumber

The task rate

custom_value1string

A custom value

custom_value2string

A custom value

custom_value3string

A custom value

custom_value4string

A custom value

is_date_basedboolean

Boolean flag determining if the task is date based

calculated_start_datestring

The calculated start date of the task

invoice_documentsboolean

Boolean flags which determines whether to include the task documents on the invoice

created_atnumber

Timestamp

updated_atnumber

Timestamp

archived_atnumber

Timestamp

hashstring

Unique hash identifier for this task

metaobject

Metadata associated with this task

status_idstring

The unique identifier of the task status

status_orderinteger

Sort order for status display

status_sort_orderinteger

Alternative sort order for status

Example response

{
  "id": "Opnel5aKBz",
  "user_id": "Opnel5aKBz",
  "assigned_user_id": "Opnel5aKBz",
  "client_id": "Opnel5aKBz",
  "invoice_id": "Opnel5aKBz",
  "project_id": "Opnel5aKBz",
  "number": "TASK-123",
  "time_log": "[[1,2],[3,4]]",
  "is_running": true,
  "is_deleted": true,
  "task_status_id": "Opnel5aKBz",
  "description": "A wonder task to work on",
  "duration": 3600,
  "task_status_order": 4,
  "rate": 10,
  "custom_value1": "2022-10-10",
  "custom_value2": "$1100",
  "custom_value3": "I need help",
  "custom_value4": "INV-3343",
  "is_date_based": true,
  "calculated_start_date": "2022-10-10",
  "invoice_documents": true,
  "created_at": 1434342123,
  "updated_at": 1434342123,
  "archived_at": 1434342123,
  "hash": "a1b2c3d4e5f6",
  "status_id": "Opnel5aKBz",
  "status_order": 1,
  "status_sort_order": 1,
  "tags": [
    {
      "id": "Opnel5aKBz",
      "name": "Urgent",
      "color": "#FF0000"
    }
  ]
}

Changes

  • 28befcbfaddaRevision changes
    • breaking

      the response property // became optional for the status

  • edde330209e2Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status