Create Task

post

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

Create a schedule task. The task may be linked to a property (property_id) and/or assigned to a staff (staff_id); both are optional. The type selects the task category and level is only meaningful for cleaning tasks.

Body Params

type

string

enum

required

Task category.

Allowed:

property_id

integer

Id of the property the task belongs to. Omit to record an unassigned task.

staff_id

integer

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

expected_date

date

required

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

expected_time

string

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

level

string

enum

Cleaning level. Only meaningful when type=cleaning.

Allowed:

currency

string

required

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

fee

number

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

note

string

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

Response

200The task has been successfully created.