Skip to main content

Update Session (v1)

Method + Path

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

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

Description

Update an existing session. All fields are optional - only provided fields will be updated.

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

Request Body

{
"name": "Updated Session Name",
"scheduledAt": "2024-01-21T10:00:00Z",
"duration": 90,
"status": "in-progress",
"notes": "Updated notes"
}

Body Parameters

ParameterTypeRequiredDescription
namestringNoSession name (minimum 1 character if provided)
scheduledAtstringNoScheduled date/time in ISO 8601 format
durationnumberNoSession duration in minutes
statusstringNoSession status. Valid values: scheduled, in-progress, completed, cancelled
notesstringNoSession notes
customFieldsarrayNoArray of custom field values

Note: At least one field must be provided for update.

Response (200)

{
"session": {
"id": "507f1f77bcf86cd799439011",
"name": "Updated Session Name",
"scheduledAt": "2024-01-21T10:00:00Z",
"duration": 90,
"status": "in-progress",
"updatedAt": "2024-01-15T11:00:00Z"
}
}

Common Errors

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