Skip to main content
PATCH
/
conversations
/
{id}
/
notes
/
{note_id}
Update a note
curl --request PATCH \
  --url https://api.getfernand.com/conversations/{id}/notes/{note_id} \
  --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"
}
Modifies the content of an existing note. Only the author of the note can edit it. The edited_at timestamp is automatically updated. Supports updating @mentions to notify additional team members. Maximum content 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 containing the note.

note_id
integer<int64>
required

ID of the note to update.

Body

application/json
content
string
required

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

Maximum string length: 10485760
mentions
string[]

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

Example:
["42", "everyone"]

Response

Note updated 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"