Sign in

v1

latestOpenAPI 3.0.32026-07-2632131.4 MB
Tasks

Create a new task

post/tasks-open-api/create-single-task

Request body

titlestring required

The name you call the task

descriptionstring

Add any additional information needed to define the task.

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

Priority value

type'cleaning' | 'maintenance' | 'inspection' | 'mid-stay' | 'runner' | 'sanitation' | 'check-in' | 'issue' | 'inventory' | 'administration'

Task types help you with better identification and reporting.

assigneeGroupstring[]

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

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.

checkliststring[]

A list of action items that help define the task.

startTimestring date-time

The date and time the task must begin (specific task). Each task scheduling should be set for fixed or flexible time. If “startTime” has value, leave “canStartFrom” and “mustFinishBefore” blank, and vice versa

canStartAfterstring date-time

The date and the time after which the task can begin (flexible task). Each task scheduling should be set for fixed or flexible time. If “startTime” has value, leave “canStartFrom” and “mustFinishBefore” blank, and vice versa

mustFinishBeforestring date-time

The date and time before which the task must be completed (flexible task). Each task scheduling should be set for fixed or flexible time. If “startTime” has value, leave “canStartFrom” and “mustFinishBefore” blank, and vice versa

listingIdstring

The object ID of the Guesty listing the task is attached to

reservationIdstring

The object ID of the Guesty reservation the task is attached to

plannedDurationnumber

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

Example request

{
  "title": "Post Stay Clean",
  "description": "A regular clean between guest stays.",
  "priority": 2,
  "type": "cleaning",
  "assigneeGroup": [
    "Cleaners A",
    "Cleaners B"
  ],
  "assigneeId": "69gvymvx55zwf5nn2ubng97cm",
  "supervisorId": "eg2x3iyeqnttngcn4mhzrzawr",
  "checklist": [
    "Clean floors",
    "Clean bathroom with bleach.",
    "Change the linen"
  ],
  "attachments": [
    {
      "title": "Clean Room 7",
      "url": "attachment.png",
      "mimetyoe": "image/png",
      "size": 4401630,
      "client": "cbt"
    }
  ],
  "startTime": "2021-05-10T11:30:00-04:00",
  "plannedDuration": 2,
  "canStartAfter": "2021-05-10T11:30:00-04:00",
  "mustFinishBefore": "2021-05-10T14:00:00-04:00",
  "listingId": "5803ca18e48f450300c76173",
  "reservationId": "5803ca18e48f450300c76173",
  "comments": [
    {
      "text": "This is a cool comment",
      "attachments": []
    }
  ]
}

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
}