notes

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.

post/work-orders/{work_order_id}/notes

Request

  • Base URL: https://api.coperniq.io/v1
  • URL: https://api.coperniq.io/v1/work-orders/{work_order_id}/notes
  • Auth: API key in header x-api-key

Path parameters

work_order_idstring required

Request body

bodystring required

Note text content (1–5000 characters).

Mention (@) tokens are supported in the body string using the format [Display Name|~id:USER_ID] (users), [Team Name|~team:TEAM_ID] (teams, notifies all members), or [Name|~agent:slug] (AI agents). The display-name portion is cosmetic; the trailing token drives the mention. A valid mention creates a feed notification for the mentioned recipient(s). The author is excluded from their own mention notifications, so mention a different user than the one the API key authenticates as to test.

fileIdsinteger[]

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

replyToIdinteger

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

Response

Note created successfully

idinteger required

Note identifier

notestring required

Note text content

createdAtstring date-time required

ISO 8601 creation timestamp

updatedAtstring date-time required

ISO 8601 last-updated timestamp

Changes

No recorded changes to this operation across all 1 revision of this API.