WOworkiz
Tasks

Update an existing Task

Changed on

Beta: Breaking changes may occur without notice.

Updates an existing Task and returns the updated Task. Requires the Tasks add-on.

put/v2/task/{id}

Request

Path parameters

idstring required
taskIdstring required
Example:TSK-3e6cca162914f48f

The task ID (prefix TSK-).

Headers

Authorizationstring required
Example:Bearer <token>

Bearer Token

Request body

status'Done' | 'Open'

The status of the task.

titlestring

The title of the task.

descriptionstring

The description of the task.

startstring

The time & date when the task starts.

endstring

The time & date when the task ends.

isAllDayboolean

Whether the task is an all-day task.

tagsstring[]

Beta: This property is subject to change.

Array of tag IDs for the task (prefix TAG-). Replaces all of the task's tags; pass an empty array to remove them all. Only task tags can be assigned.

techIdsstring[]

Array of tech IDs assigned to the task (prefix USR-). Pass an empty array to remove all technicians.

Example request

{
  "title": "Doctor appointment",
  "description": "Doctor appointment with Dr. Smith",
  "start": "2024-07-25 09:00:00",
  "end": "2024-07-25 11:00:00",
  "tags": [
    "TAG-16a94b03317f6e64"
  ],
  "techIds": [
    "USR-83510a9930f203f4",
    "USR-a4f86bf1deefec12",
    "USR-d59dbcd34aa19dce"
  ]
}

Response

The updated Task.

idstring

The ID of the task (prefix TSK-).

status'Done' | 'Open'

The status of the task.

titlestring

The title of the task.

descriptionstring

The description of the task.

startstring

The time & date when the task starts.

endstring

The time & date when the task ends.

isAllDayboolean

Whether the task is an all-day task.

techIdsstring[]

Array of tech IDs assigned to the task (prefix USR-).

parentType'job' | 'lead'

The parent type of the task.

parentIdstring

The ID of the parent job or lead (prefix JOB- or LD-).

isDeletedboolean

Whether the task is deleted.

updatedAtstring

The date and time the task was updated.

createdAtstring

The date and time the task was created.

Example response

{
  "id": "TSK-3e6cca162914f48f",
  "title": "Doctor appointment",
  "description": "Doctor appointment with Dr. Smith",
  "start": "2024-07-25 09:00:00",
  "end": "2024-07-25 11:00:00",
  "tags": [
    {
      "id": "TAG-8cddc18e7b0458fa",
      "name": "Estimate"
    }
  ],
  "techIds": [
    "USR-83510a9930f203f4",
    "USR-a4f86bf1deefec12",
    "USR-d59dbcd34aa19dce"
  ],
  "parentId": "JOB-BA5r7o4bqzR9MONa",
  "updatedAt": "2024-07-25 09:00:00",
  "createdAt": "2024-07-25 09:00:00"
}

Changes

  • fb557783146cRevision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      response property message list-of-types was narrowed by removing types array from media type application/json of response 403

  • bb1c25c92b05Revision changes
    • info

      endpoint added