Create Session Note (v1)
Method + Path
POST /v1/workspace/:workspaceId/sessions/:sessionId/notes
Actual backend path: /v1/workspace/:workspaceId/sessions/:sessionId/notes
Description
Add a note to a session.
Authentication
Required - JWT token in Authorization header
Required Permissions:
sessions.vieworsessions.update
Headers
| Header | Type | Required | Description |
|---|---|---|---|
Authorization | string | Yes | Bearer token: Bearer <token> |
Content-Type | string | Yes | application/json |
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
workspaceId | string | Yes | Workspace identifier |
sessionId | string | Yes | Session identifier |
Request Body
{
"authorId": "507f1f77bcf86cd799439012",
"authorType": "staff",
"authorName": "John Doe",
"body": "Client arrived on time. Session went well."
}
Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
authorId | string | Yes | ID of the note author |
authorType | string | Yes | Type of author. Valid values: staff, workspace |
authorName | string | Yes | Name of the note author |
body | string | Yes | Note text (minimum 1 character) |
Response (201)
{
"note": {
"id": "507f1f77bcf86cd799439013",
"authorId": "507f1f77bcf86cd799439012",
"authorType": "staff",
"authorName": "John Doe",
"body": "Client arrived on time. Session went well.",
"createdAt": "2024-01-15T11:00:00Z"
}
}
Common Errors
- 400 Bad Request: Invalid request body
- 401 Unauthorized: Missing or invalid authentication token
- 403 Forbidden: Insufficient permissions
- 404 Not Found: Session or workspace not found
- 422 Unprocessable Entity: Validation errors
- 500 Internal Server Error: Server error