Skip to main content
PATCH
Update a work order

Authorizations

Authorization
string
header
required

Organization API key with an sk_live_ or sk_test_ prefix

Path Parameters

id
string
required

Resource ID

Body

application/json
title
string
Maximum string length: 255
description
string | null
Maximum string length: 5000
type
enum<string> | null
Available options:
preventive,
reactive,
other,
cycle_count
status
enum<string>
Available options:
open,
on_hold,
in_progress,
done,
canceled,
skipped
priority
enum<string>
Available options:
low,
medium,
high,
critical
requested_by
string | null
Maximum string length: 255
assigned_to_user_id
string | null
assigned_to_team_id
string | null
asset_id
string | null
location_id
string | null
due_date
string<date-time> | null
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
extraFields
object

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

Response

Work order updated

data
object
required
meta
object
required