Skip to content
developers
Open TestCollab

Updates a task

PUT/tasks/{id}

Task to update

Example

Section titled “Example”

Use resource IDs from your own project. Keep the API token in your server or CI environment.

example.ts
import { createConfiguration, TasksApi } from '@testcollab/sdk';


const config = createConfiguration(process.env.TESTCOLLAB_TOKEN!);
const api = new TasksApi(config);


const result = await api.updateTask({
  "id": 123,
  "taskPayload": {
    "project": 123,
    "company": 123,
    "completed": false
  }
});
console.log(result);

Parameters

Section titled “Parameters”
Name Location Type Required Description
id path number Yes Task ID

Request body

Section titled “Request body”
Field Type Required Description
id number No Task ID - optional
project number Yes —
company number Yes —
title string No —
completed boolean Yes —
href string No —
priority number No Priority, 0 - Low, 1- Normal, 2 - High Values: 0, 1, 2.
start_date string No —
end_date string No —

Response

Section titled “Response”

200 — Updated Task

Field Type Required Description
id number Yes —
project Project Mini Yes —
project.id number Yes —
project.name string Yes —
project.archived boolean Yes —
project.activity string No —
project.totalTimeSpentLabel string No —
project.created_at string Yes —
project.updated_at string Yes —
user User Minified Yes —
user.id number Yes —
user.username string No —
user.name string Yes —
user.avatar Upload No —
user.avatar.id number Yes —
user.avatar.name string Yes —
user.avatar.hash string Yes —
user.avatar.ext string Yes —
user.avatar.mime string Yes —
user.avatar.size string Yes —
user.avatar.url string Yes —
user.avatar.created_by number No —
user.avatar.created_at string Yes —
user.avatar.updated_at string Yes —
user.is_guest number No —
title string Yes —
completed boolean No —
priority number No Priority, 0 - Low, 1- Normal, 2 - High Values: 0, 1, 2.
start_date string No —
end_date string No —
href string Yes —
created_at string Yes —
updated_at string Yes —
Illustrative response
{
  "id": 123,
  "project": {
    "id": 123,
    "name": "example",
    "archived": true,
    "activity": "example",
    "totalTimeSpentLabel": "example",
    "created_at": "example",
    "updated_at": "example"
  },
  "user": {
    "id": 123,
    "username": "example",
    "name": "example",
    "avatar": {
      "id": 123,
      "name": "example",
      "hash": "example",
      "ext": "example",
      "mime": "example",
      "size": "example",
      "url": "example",
      "created_by": 123,
      "created_at": "example"
    },
    "is_guest": 123
  },
  "title": "example",
  "completed": true,
  "priority": 0,
  "start_date": "example",
  "end_date": "example",
  "href": "example"
}

Errors

Section titled “Errors”
Status Meaning
403 Forbidden

Next steps

Section titled “Next steps”