Skip to main content
PATCH
/
v1
/
notes
/
{id}

curl --request PATCH \
 --url https://api.caret.so/v1/notes/note_123456789 \
 --header 'Authorization: Bearer <your_api_key>' \
 --header 'Content-Type: application/json' \
 --data '{
"title": "Updated Meeting Title",
"visibility": "workspace",
"userWrittenNote": "# Meeting Notes\n\nKey discussion points..."
}'

{
  "note": {
    "id": "note_123456789",
    "title": "Updated Meeting Title",
    "kind": "online",
    "status": "completed",
    "createdAt": "2024-01-28T10:00:00Z",
    "updatedAt": "2024-01-28T14:30:00Z",
    "visibility": "workspace",
    "tags": [],
    "participants": [],
    "totalDurationSec": 3600,
    "userWrittenNote": "# Meeting Notes\n\nKey discussion points...",
    "enhancedNote": "Meeting summary content...",
    "summary": "Meeting summary content...",
    "transcripts": [],
    "calendarEvent": null,
    "inputLanguage": "en",
    "translationLanguage": null,
    "meetingApp": null
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.caret.so/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

id
string
required
The unique identifier of the note

Request Body

title
string
The title of the meeting note
visibility
string
Visibility/permission setting for the note. Options: workspace, public, only-me, private, sharedNote: private is an alias for only-me, shared is an alias for public
userWrittenNote
string
Note content written by the user in markdown format
tagIds
string[]
deprecated
Deprecated: Tags have been removed. This parameter is accepted but ignored for backward compatibility

Response

note
Note
The updated note object with all fields (same schema as Get Note)

curl --request PATCH \
 --url https://api.caret.so/v1/notes/note_123456789 \
 --header 'Authorization: Bearer <your_api_key>' \
 --header 'Content-Type: application/json' \
 --data '{
"title": "Updated Meeting Title",
"visibility": "workspace",
"userWrittenNote": "# Meeting Notes\n\nKey discussion points..."
}'

{
  "note": {
    "id": "note_123456789",
    "title": "Updated Meeting Title",
    "kind": "online",
    "status": "completed",
    "createdAt": "2024-01-28T10:00:00Z",
    "updatedAt": "2024-01-28T14:30:00Z",
    "visibility": "workspace",
    "tags": [],
    "participants": [],
    "totalDurationSec": 3600,
    "userWrittenNote": "# Meeting Notes\n\nKey discussion points...",
    "enhancedNote": "Meeting summary content...",
    "summary": "Meeting summary content...",
    "transcripts": [],
    "calendarEvent": null,
    "inputLanguage": "en",
    "translationLanguage": null,
    "meetingApp": null
  }
}