Skip to main content
PATCH
Update note content
Updates the content of an existing note.
Only the original author may edit a note.

Path Parameters

  • id (required, string): Note ID, from List Notes.

Request Body

Example Request

Response (200)

Returns the updated note object.

Errors

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

Note ID

Body

application/json
content
string
required

Updated plain text content of the note

Maximum string length: 10000
Example:

"Updated note content"

user_id
string
required

ID of the team member performing the update. Must match the original author of the note.

Example:

"507f1f77bcf86cd799439011"

Response

Note updated successfully

_id
string
Example:

"507f1f77bcf86cd799439011"

team
string
Example:

"507f1f77bcf86cd799439012"

author
object

Note author. Populated when available; otherwise just the user ID under _id.

content
string

Plain text content of the note

is_pinned
boolean

Whether this note is pinned to the top

pinned_at
string<date-time> | null
pinned_by
string | null
contact
string | null

Contact this note is attached to (mutually exclusive with company)

company
string | null

Company this note is attached to (mutually exclusive with contact)

createdAt
string<date-time>
updatedAt
string<date-time>