Skip to main content

Update Evaluation (v1)

Method + Path

PATCH /v1/public/evaluation/:token

Actual backend path: /v1/public/evaluation/:token

Description

Submit session evaluation using an evaluation token. This endpoint allows clients to provide feedback after a session without requiring authentication.

Authentication

Not required - This is a public endpoint (token-based access)

Headers

HeaderTypeRequiredDescription
Content-TypestringYesapplication/json

Path Parameters

ParameterTypeRequiredDescription
tokenstringYesEvaluation token (provided by staff after session)

Request Body

{
"evaluationValues": [
{
"fieldId": "507f1f77bcf86cd799439013",
"value": 5
},
{
"fieldKey": "satisfaction-rating",
"value": 5
},
{
"fieldKey": "comments",
"value": "Great session, very helpful!"
}
]
}

Body Parameters

ParameterTypeRequiredDescription
evaluationValuesarrayNoArray of evaluation field values
evaluationValues[].fieldIdstringConditionalField ID (required if fieldKey not provided)
evaluationValues[].fieldKeystringConditionalField key (required if fieldId not provided)
evaluationValues[].valueunknownYesField value (type depends on field definition)

Response (200)

{
"session": {
"id": "507f1f77bcf86cd799439011",
"evaluationValues": [
{
"fieldId": "507f1f77bcf86cd799439013",
"value": 5
}
],
"updatedAt": "2024-01-15T11:00:00Z"
}
}

Common Errors

  • 400 Bad Request: Invalid token or request body
  • 404 Not Found: Session not found or token invalid
  • 422 Unprocessable Entity: Validation errors
  • 500 Internal Server Error: Server error