Sign in

v1

latestOpenAPI 3.0.32026-07-2632131.4 MB
Tasks

Delete a task

delete/tasks-open-api/{taskId}

Path parameters

taskIdstring required

Task id

Response

Successful operation

_idstring

The unique identifier of the task.

assigneeGroupstring[]

The team the assignees is part of. This is a tag

typestring

Task types help you with better identification and reporting.

checklistFinishedstring[]

A list of finished action items that help define the task.

checkliststring[]

A list of action items that help define the task.

tagsstring[]

List of tags the task is related to

statusstring

The status of the task, being one of the following enumerators: pending,confirmed, in progress,completed,canceled.

accountIdstring

The ID of the account the task is attached to

createdBystring

The ID of the user who created the task.

titlestring

The name you call the task

descriptionstring

Add any additional information needed to define the task.

priority'medium' | 'high' | 'low'

Assign the level of importance to the task in enumerators - High,Medium,Low

assigneeIdstring

The unique Guesty identifier of the person assigned to the task.

supervisorIdstring

The unique Guesty identifier of the person assigned to supervise the task.

timezonestring
plannedDurationnumber

The amount of time budgeted for the task (hours).

Example response

{
  "_id": "5fc628f3d6391a00363234d",
  "assigneeGroup": [
    "cleaners"
  ],
  "checklistFinished": [
    "Clean room A",
    "Clean room B"
  ],
  "checklist": [
    "Clean room A",
    "Clean room B"
  ],
  "tags": [],
  "status": "confirmed",
  "accountId": "Q5fb67280e396Q77002e6c2683",
  "createdBy": "Q5fb67280e39Q677002e6c268c",
  "title": "Post Stay Clean",
  "checklistAggregated": [
    {
      "name": "Clean room A",
      "finished": "true",
      "at": "2024-01-06T21:08:53.990Z",
      "by": ""
    },
    {
      "name": "Clean room B",
      "finished": "False"
    }
  ],
  "attachments": [
    {
      "_id": "6599c15c1d103f000e6464de",
      "mimetype": "image/png",
      "size": 31356,
      "client": "cbt",
      "title": "",
      "url": ""
    }
  ],
  "comments": [],
  "createdAt": "2020-12-01T11:28:51.968Z",
  "updatedAt": "2024-01-06T21:08:55.193Z",
  "assigneeId": null,
  "priority": "high",
  "supervisorId": "64a6b8cfa08e0446a6f4b840",
  "plannedDuration": 0.08,
  "description": "A regular clean between guest stays.",
  "startedAt": "2020-12-02T07:35:24.333Z",
  "enumeratedStatus": 1,
  "timezone": "Australia/Sydney",
  "afterEffects": [],
  "endTime": "2024-01-10T21:04:48.000Z",
  "timing": {
    "type": "specific",
    "startTime": "2024-01-10T21:00:00.000Z"
  },
  "apply": {
    "type": "reservation",
    "listingId": "5fba2d97d8e638002d76d842",
    "reservationId": "9fba3d97d8e62500Gd7f6d842"
  },
  "assignedToMyGroup": false
}