API Reference

Create task

post
https://api.breezeway.io/public/inventory/v1/task
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int32

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

int32

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

string
required

Name of task

string
enum
Allowed:
string
enum
Allowed:
string

Description of task

int32

Template ID from Breezeway system

date

Date task is scheduled; ISO 8601 format

string

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

assignments
array of int32s

Array of person IDs from Breezeway system

assignments
tags
array of int32s

Array of task tag IDs from Breezeway system

tags
int32

Subdepartment ID from Breezeway system

float

Rate paid

string
enum
Defaults to piece

Rate type

Allowed:
string
enum

Type of entity that made the request

boolean
Defaults to false

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

Responses

Updated 10 months 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 10 months ago