Skip to main content
PUT
Replace a work order's labels

Authorizations

X-API-KEY
string
header
required
OW-KEY
string
header
required

OpenWrench shared secret. Required on every request alongside X-API-KEY; issued together with your API key.

Path Parameters

woId
integer
required

Work order id.

Body

application/json

Full replacement set of label ids. Send an empty array to clear all labels.

ids
integer[]
required

Ids of labels from the corresponding label catalog. Duplicates are de-duplicated.

Response

Success. Returns the label mappings now active on the work order.

type
string
required

Entity type marker, "WorkOrderLabelMapping".

data
object[]
required
count
integer
required

Number of mappings returned (the labels now active on the work order).

status
enum<string>
required
Available options:
ok