Unit: update a single student's grade or Pass/Fail status

​

Updates a single student's grade value and/or Pass/Fail status for a unit. Send grade_name (either final or a partial grade name, e.g. __coursework) together with grade_value to record a grade on the unit's scale; send grade_state to set the Pass/Fail status. Changes to a grade or status that is already published are ignored. Publishing is done via the grades/publish and grades/unpublish endpoints. The student must already be registered to the unit.

Path Parameters
  • unit_id
    Type: string
    required

    Unique identifier of the unit.

Body
required
application/json
  • profile_id
    Type: string
    required

    ID of the student profile.

  • grade_name
    Type: string

    Name of the grade to update. Use final for the overall grade or the partial grade name (e.g. __coursework). Provide together with grade_value.

  • grade_state
    Type: string

    Pass/Fail grade state to set — pass, fail, unknown, or a custom grade state name. Ignored if the result is already published.

  • grade_value
    Type: number

    Grade value on the grade's scale. Provide together with grade_name. Send null to clear it.

Responses
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/apis/units/units/{unit_id}/grades
curl https://ff-business-school.fullfabric.cloud/apis/units/units/507f1f77bcf86cd799439011/grades \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'FF-Auth: YOUR_SECRET_TOKEN' \
  --data '{
  "profile_id": "6385bdd4976a7719120108e9",
  "grade_name": "final",
  "grade_value": 80
}'

{
  "id": "681ba4d6b17887f608053456",
  "transcript_id": "681b7ab7108f0da30cc0e8a7",
  "transcript_subject_id": "681b7ab7108f0da30cc0e8a9",
  "unit_id": "6385baad976a7719120008e3",
  "registration_state": "registered",
  "published": true,
  "awarded": true,
  "grade_state_name": "pass",
  "grade_notes": "",
  "grade_feedback": "",
  "grades": [
    {
      "label": "Final grade",
      "name": "final",
      "published": true,
      "value": "80"
    }
  ],
  "created_at": 1746642134000,
  "updated_at": 1746642814000
}

Successful response.