Create Work Order Note | Coperniq API

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

work_order_idstringRequired

Request

This endpoint expects an object.

bodystringRequired1-5000 characters

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.

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.

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

1	const url = 'https://api.coperniq.io/v1/work-orders/work_order_id/notes';
2	const options = {
3	method: 'POST',
4	headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
5	body: '{"body":"Inspection completed. Panel alignment verified. [Nicolaus Copernicus\|~id:99001]"}'
6	};
7
8	try {
9	const response = await fetch(url, options);
10	const data = await response.json();
11	console.log(data);
12	} catch (error) {
13	console.error(error);
14	}

1	{
2	"id": 12345,
3	"note": "Inspection completed. Panel alignment verified.",
4	"createdAt": "2026-04-15T12:00:00.000Z",
5	"updatedAt": "2026-04-15T12:00:00.000Z"
6	}