API Reference

Create Task

post
https://api.hostex.io/v3/tasks

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.

Body Params
string
enum
required

Task category.

Allowed:
string

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).

integer

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

integer

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

date
required

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

string

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

string
enum

Cleaning level. Only meaningful when type=cleaning.

Allowed:
string
required

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

number

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

string

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

Response

Updated 2 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 days ago