Skip to main content

Update Session Note (v1)

Method + Path​

PATCH /v1/workspace/:workspaceId/sessions/:sessionId/notes/:noteId

Actual backend path: /v1/workspace/:workspaceId/sessions/:sessionId/notes/:noteId

Description​

Update an existing session note.

Authentication​

Required - JWT token in Authorization header

Required Permissions:

  • sessions.update

Headers​

HeaderTypeRequiredDescription
AuthorizationstringYesBearer token: Bearer <token>
Content-TypestringYesapplication/json

Path Parameters​

ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace identifier
sessionIdstringYesSession identifier
noteIdstringYesNote identifier

Request Body​

{
"body": "Updated note text"
}

Body Parameters​

ParameterTypeRequiredDescription
bodystringYesUpdated note text (minimum 1 character)

Response (200)​

{
"note": {
"id": "507f1f77bcf86cd799439013",
"body": "Updated note text",
"updatedAt": "2024-01-15T11:00:00Z"
}
}

Common Errors​

  • 400 Bad Request: Invalid request body
  • 401 Unauthorized: Missing or invalid authentication token
  • 403 Forbidden: Insufficient permissions (requires sessions.update)
  • 404 Not Found: Note, session, or workspace not found
  • 422 Unprocessable Entity: Validation errors
  • 500 Internal Server Error: Server error