Skip to main content
POST
Create a work

Authorizations

Authorization
string
header
required

An API key created in BeanRails, for example brk_live_....

Body

application/json
work_date
string<date>
required

YYYY-MM-DD, in the workspace timezone.

attention
string
required

The person to see on site.

Maximum string length: 255
address1
string
required
Maximum string length: 255
time_window_from
string

HH:mm.

time_window_to
string

HH:mm, after time_window_from.

work_number
string

Required only when the workspace does not number works automatically.

contact_id
integer
vehicle_id
integer
zone_id
integer
service_type
enum<string>
Available options:
service,
engineering
email
string
company_name
string
mobile_no
string
office_no
string
address2
string
city
string
state
string
postcode
string
country
string

Two letter country code.

user_lat
number
user_lng
number
work_price
number
instructions
string
is_collect_work_price
boolean
is_auto_reschedule
boolean
vehicles
integer[]

Additional helper vehicle IDs.

items
object[]

Response

The created work.

data
object