Skip to main content
PATCH
Append a note to a work order

Autorizaciones

X-API-KEY
string
header
requerido
OW-KEY
string
header
requerido

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

Cuerpo

application/json
id
integer
requerido

Work order id.

note
object | null

The note to append (text and noteAddedBy required; noteAddedAt is replaced server-side). Technically optional — omitting it makes the call a no-op save.

taggedUsers
string<email>[]

Contact email addresses to @mention on the note. Each email is trimmed, lowercased and validated, then folded into note.elements as a user element, so you do not need to build the elements structure yourself. Duplicates in the list and users already tagged in note.elements are skipped. Requires a note object to tag people on. An entry that is not a valid email address, or a list of more than 25 emails, is rejected with 400 invalidInputDataException and nothing is persisted. An empty list is ignored.

Maximum array length: 25

Respuesta

Success.

type
string
requerido

Entity type marker, e.g. "WorkOrder".

data
object
requerido

Work order. ABRIDGED: the full case class has 150+ fields (hydrated approval hierarchies, budgets, troubleshooting answers, contractor/sub-contractor details, internal workspaces, labels, stars, etc.); only the commonly used fields are listed here and additional properties may appear in responses.

status
enum<string>
requerido
Opciones disponibles:
ok