Create Account Note | Coperniq API

Add a new note on an account

Note: The /clients/{client_id}/comments path will continue to work until users are notified and migrated to the new naming.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

account_idintegerRequired

Account identifier

Request

This endpoint expects an object.

bodystringRequired

Note text content.

To mention (@) a user, team, or AI agent, embed a mention token directly in the body string using the format [Display Name|~id:USER_ID]. The display-name portion is cosmetic; the trailing token is what drives the mention. A valid mention creates a feed notification (and downstream channels) for the mentioned recipient(s).

Supported tokens:

User: [Display Name|~id:USER_ID] — e.g. Please review [Nicolaus Copernicus|~id:99001]
Team: [Team Name|~team:TEAM_ID] — notifies all team members
AI agent: [Name|~agent:slug]

Note: the author is excluded from their own mention notifications, so mentioning the same user the API key authenticates as will not fire a notification. Mention a different user to test.

replyToIdintegerOptional

ID of the parent note to reply to. When provided, the new note is created as a threaded reply under the specified note.

Response

Note created successfully

idinteger

Note identifier

notestring

Note text content

createdAtstringformat: "date-time"

Creation timestamp

updatedAtstringformat: "date-time"

Last update timestamp

1	const url = 'https://api.coperniq.io/v1/accounts/1/notes';
2	const options = {
3	method: 'POST',
4	headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
5	body: '{"body":"Please review [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": 1,
3	"note": "string",
4	"createdAt": "2024-01-15T09:30:00Z",
5	"updatedAt": "2024-01-15T09:30:00Z"
6	}