Sign in

v1

latestOpenAPI 3.0.32026-07-2632131.4 MB
Tasks

Update a task

put/tasks-open-api/{taskId}

Path parameters

taskIdstring required

Task id

Request body

titlestring

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

status'pending' | 'confirmed' | 'in progress' | 'completed' | 'canceled'
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