Sign in

v1

latestOpenAPI 3.0.02026-07-26866217.8 KB
Task

Create Task

Create a schedule task. The task may be linked to a property (property_id), to a specific stay (stay_code), and/or assigned to a staff (staff_id); all are optional. When stay_code is provided the task is linked to the reservation; property_id is inferred from the stay when omitted (and must match the stay's property when both are supplied). The type selects the task category and level is only meaningful for cleaning tasks.

post/tasks

Request body

type'cleaning' | 'maintenance' | 'reception' | 'room_service' | 'other' required

Task category.

stay_codestring

Stay code to link the task to a specific reservation. When provided, the task is linked to the reservation and property_id defaults to the stay's property (an explicit property_id must match).

property_idinteger

Id of the property the task belongs to. Omit to record an unassigned task (or to inherit from stay_code when supplied).

staff_idinteger

Id of the staff to assign. Omit to leave the task unassigned.

expected_datestring date required

Expected execution date in YYYY-MM-DD. Interpreted in the operator's configured timezone (see Account Settings).

expected_timestring

Expected execution time in HH:mm:ss. Optional. Interpreted in the operator's configured timezone.

level'standard' | 'simple' | 'advanced'

Cleaning level. Only meaningful when type=cleaning.

currencystring required

Currency code for fee. See Supported Currencies for more information.

feenumber

Task fee. Defaults to 0 (or to the property's configured cleaning fee for cleaning tasks linked to a property when omitted).

notestring

Free-form note attached to the task (max 500 characters).

Response

The task has been successfully created.

request_idstring required

Unique identifier for the request.

error_codeinteger required

Numeric error code representing the status of the response. A value of 200 indicates success. <br> See the Error Codes section for more information.

error_msgstring required

Message detailing the status of the response.

Example response

{
  "error_msg": "Done."
}