Update details of a specific note by its ID.

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, private, shared

userWrittenNote
string

Note content written by the user in markdown format

tagIds
array

Array of tag IDs to associate with the note

Response

Returns the updated note with the same structure as the GET /notes/ endpoint.

note
object

Note details (same as GET /notes/ response)

Example Request

curl -X PATCH 'https://api.caret.so/v1/notes/01887270-12d4-7da0-b95c-9a9e9ebc3b13' \
  -H 'Authorization: Bearer {api_key}' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Updated Meeting with Acme Corp",
    "visibility": "workspace",
    "userWrittenNote": "## Key Points\n\n- Discussed integration timeline\n- Requirements finalized\n- Next steps agreed",
    "tagIds": ["01887270-23f5-7da0-b95c-9a9e9ebc3c25", "01887270-33f6-7da0-b95c-9a9e9ebc3d36"]
  }'

Example Response

{
  "note": {
    "id": "01887270-12d4-7da0-b95c-9a9e9ebc3b13",
    "title": "Updated Meeting with Acme Corp",
    "kind": "online",
    "status": "completed",
    "createdAt": "2023-08-01T15:30:00Z",
    "updatedAt": "2023-08-02T10:15:00Z",
    "visibility": "workspace",
    "tags": [
      {
        "id": "01887270-23f5-7da0-b95c-9a9e9ebc3c25",
        "name": "Sales",
        "color": "#FF5733"
      },
      {
        "id": "01887270-33f6-7da0-b95c-9a9e9ebc3d36",
        "name": "Integration",
        "color": "#3366FF"
      }
    ],
    "participants": [
      {
        "name": "John Doe",
        "email": "john@example.com",
        "profileImageUrl": "https://example.com/profiles/john.jpg",
        "accountName": "Caret",
        "accountDomain": "caret.so",
        "accountImageUrl": "https://example.com/logos/caret.png"
      },
      {
        "name": "Jane Smith",
        "email": "jane@acme.com",
        "profileImageUrl": "https://example.com/profiles/jane.jpg",
        "accountName": "Acme Corp",
        "accountDomain": "acme.com",
        "accountImageUrl": "https://example.com/logos/acme.png"
      }
    ],
    "totalDurationSec": 3600,
    "userWrittenNote": "## Key Points\n\n- Discussed integration timeline\n- Requirements finalized\n- Next steps agreed",
    "summary": "Discussed new feature requests and timeline for implementation.",
    "transcripts": [
      {
        "speaker": "John",
        "text": "Hello Jane, thank you for joining today's call to discuss the integration timeline.",
        "startTimestamp": "00:05",
        "endTimestamp": "00:12"
      },
      {
        "speaker": "Jane",
        "text": "Hi John, happy to be here. I'm looking forward to discussing the roadmap.",
        "startTimestamp": "00:13",
        "endTimestamp": "00:20"
      }
    ]
  }
}