notes

Create Opportunity Note

Add a new note on an opportunity

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

post/opportunities/{opportunity_id}/notes

Request

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

Path parameters

opportunity_idinteger required

Opportunity identifier

Request body

bodystring required

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.

replyToIdinteger

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 required

Note identifier

notestring required

Note text content

createdAtstring date-time required

Creation timestamp

updatedAtstring date-time required

Last update timestamp

Changes

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