Skip to main content
POST
Create a work order

Authorizations

Authorization
string
header
required

Organization API key with an sk_live_ or sk_test_ prefix

Body

application/json
title
string
required
Maximum string length: 255
description
string
Maximum string length: 5000
type
enum<string> | null
Available options:
preventive,
reactive,
other,
cycle_count
status
enum<string>
default:open
Available options:
open,
on_hold,
in_progress,
done,
canceled,
skipped
priority
enum<string>
default:none
Available options:
none,
low,
medium,
high,
critical
requested_by
string
Maximum string length: 255
assigned_to_user_ids
string[]

Directly assigned users. On update, replaces this set; omission preserves it and an empty array clears it. May coexist with assigned_to_team_ids.

Maximum array length: 100
Minimum string length: 1
assigned_to_team_ids
string[]

Assigned teams. On update, replaces this set; omission preserves it and an empty array clears it. Team membership is resolved dynamically.

Maximum array length: 100
Minimum string length: 1
assigned_to_user_id
string
deprecated

Legacy scalar assignment. Use assignment arrays for mixed assignments or to change an order with multiple targets.

assigned_to_team_id
string
deprecated

Legacy scalar assignment. Use assignment arrays for mixed assignments or to change an order with multiple targets.

asset_id
string
location_id
string
due_date
string<date-time>
scheduled_start
string<date-time> | null
estimated_hours
number<double> | null
Required range: 0 <= x <= 9999.99
completion_summary
string | null
Maximum string length: 5000
workRequestId
string | null

Approves this pending Work Request and atomically links the created Work Order. A replay returns the already linked Work Order.

extraFields
object

Label-keyed custom-field values. Omitted labels remain unchanged on update.

Response

Work order created

data
object
required
meta
object
required