BRbreezeway

Create task

post/task

Request

  • Base URL
    https://api.breezeway.io/public/inventory/v1
  • URL
    https://api.breezeway.io/public/inventory/v1/task
  • Auth
    API key in header Authorization

Request body

home_idinteger

Property ID from Breezeway system (required if referece_property_id is omitted)

reference_property_idinteger

Property ID from external system (required if home_id is omitted)

namestring required

Name of task

type_department'housekeeping' | 'inspection' | 'maintenance' | 'safety'
type_priority'urgent' | 'high' | 'normal' | 'low' | 'watch'
descriptionstring

Description of task

template_idinteger

Template ID from Breezeway system

scheduled_datestring date

Date task is scheduled; ISO 8601 format

scheduled_timestring

Time task is scheduled; ISO 8601 format (HH:MM:SS)

assignmentsinteger[]

Array of person IDs from Breezeway system

tagsinteger[]

Array of task tag IDs from Breezeway system

subdepartment_idinteger

Subdepartment ID from Breezeway system

rate_paidnumber float

Rate paid

rate_type''hourly'' | ''piece''

Rate type

requested_by''owner'' | ''guest'' | ''guest_survey'' | ''inspector'' | ''housekeeper'' | ''maintenance_tech'' | ''property_services'' | ''property_manager'' | ''damage'' | ''internal'' | ''insurance'' | ''dispatcher'' | ''review''

Type of entity that made the request

reported_issueboolean

Indicates whether the task is a reported issue or not

assign_default_workersboolean

When set to true, it will assign task with default workers, prioritizing assignees from template, then by department. Default assignees will be added to any manually sent assignees

Response

201

Changes

No recorded changes to this operation across all 1 revision of this API.