Create Work Order Note

Add a note (comment) to a specific work order.

Notes are stored as internal comments linked to the work order. They trigger the same notification and feed pipeline as comments created in the Coperniq UI.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

workOrderIdstringRequired

Request

This endpoint expects an object.
bodystringRequired1-5000 characters

Note text content (1–5000 characters).

fileIdslist of integersOptional

Optional array of file IDs (previously uploaded) to attach to the note.

replyToIdintegerOptional
ID of the note to reply to. Creates a threaded reply on the parent note.

Response

Note created successfully
idinteger
Note identifier
notestring
Note text content
createdAtstringformat: "date-time"
ISO 8601 creation timestamp
updatedAtstringformat: "date-time"

ISO 8601 last-updated timestamp

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error