Skip to main content
POST
/
conversations
/
{id}
/
notes
Add a note to a conversation
curl --request POST \
  --url https://api.getfernand.com/conversations/{id}/notes \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "content": "<string>"
}
'
{
  "id": "n-123456",
  "conversation_id": 12345,
  "message": "<p>Customer mentioned they prefer email communication.</p>",
  "created": "2026-01-21T14:30:00Z",
  "type": "NOTE",
  "timestamp": "2026-01-21T14:30:00Z",
  "agent_id": 42,
  "actions": [
    {}
  ],
  "edited_at": "2026-01-21T15:00:00Z"
}
Creates an internal note within a conversation that is only visible to team members. Notes support HTML content, @mentions to notify specific agents, and can trigger automated actions. Maximum size is 8MB.

Authorizations

​
X-API-Key
string
header
required

Authenticate your account by including your secret key in API requests. You can manage your API keys in the Dashboard.

Authentication to the API is performed by using the HTTP Header X-API-Key.

Path Parameters

​
id
integer<int64>
required

ID of the conversation to add the note to.

Body

application/json
​
content
string
required

HTML content of the note (required, max 8MB).

Maximum string length: 10485760
​
mentions
string[]

Array of agent IDs or special mentions to notify. Use "everyone" to notify all team members.

Example:
["42", "everyone"]
​
actions
object[]

Automated actions to execute after creating the note (optional).

​
note_id
integer<int64>

If updating an existing draft note, provide its ID (optional).

​
generated_id
string

Client-generated ID to track the note in the response (optional, returned unchanged).

Response

Note added successfully.

​
id
string
required

Unique identifier for the note

Example:

"n-123456"

​
conversation_id
integer<int64>
required

ID of the conversation this note belongs to

Example:

12345

​
message
string
required

HTML content of the note

Example:

"<p>Customer mentioned they prefer email communication.</p>"

​
created
string<date-time>
required

ISO 8601 timestamp when the note was created

Example:

"2026-01-21T14:30:00Z"

​
type
enum<string>
required

Type of entry (always NOTE for conversation notes)

Available options:
NOTE
Example:

"NOTE"

​
timestamp
string<date-time>
required

ISO 8601 timestamp for sorting entries (same as created)

Example:

"2026-01-21T14:30:00Z"

​
agent_id
integer<int64> | null

ID of the agent who created the note

Example:

42

​
actions
object[]

Array of automated actions triggered by this note

​
edited_at
string<date-time> | null

ISO 8601 timestamp when the note was last edited, or null if never edited

Example:

"2026-01-21T15:00:00Z"