Skip to main content
PATCH
Update a note
Replaces the text of an existing note. The new content replaces the old text entirely and updatedAt changes; the pin state and the record the note is attached to stay as they are.
Only the original author may edit a note: user_id must equal the note’s author._id. Any other team member gets 403.
Sending the same request again leaves the note unchanged, so it is safe to retry.

Path parameters

Request body

Example request

Response (200)

Returns the updated note object.

Errors

Authorizations

x-api-key
string
header
required

Team-scoped API key generated in the Salesfinity dashboard under Settings → Connections → API & Webhooks. A missing or invalid key returns HTTP 403.

Path Parameters

id
string
required

The note's _id, as returned by List notes or Create a note. A 24-character hex string.

Example:

"6703f1c2a9e4b8d1c2f3a4b5"

Body

application/json
content
string
required

New plain text for the note, 1 to 10,000 characters. Replaces the old text entirely.

Maximum string length: 10000
Example:

"Confirmed budget approved for Q3."

user_id
string
required

ID of the member making the change, a 24-character hex string. Must be the note's author.

Example:

"507f1f77bcf86cd799439033"

Response

The updated note.

_id
string

Note ID.

Example:

"6703f1c2a9e4b8d1c2f3a4b5"

team
string

Team that owns the note.

Example:

"507f1f77bcf86cd799439012"

author
object

The author, with first_name, last_name, email and image when Salesfinity has them. null if the author's user record no longer exists.

content
string

Plain text of the note.

is_pinned
boolean

Whether the note is pinned. false for a new note.

pinned_at
string<date-time> | null

When the note was pinned. Absent when the note is not pinned.

pinned_by
string | null

ID of the member who pinned the note. Absent when the note is not pinned.

contact
string | null

ID of the contact the note is attached to. Present on person notes only.

company
string | null

ID of the company the note is attached to. Present on company notes only.

createdAt
string<date-time>

When the note was created.

updatedAt
string<date-time>

When the note was last changed, including pin changes.