Update a classwork part reference

PATCH /v1/classwork/{id}/parts/{referenceId}

Update a classwork part reference

Requires: classwork.editor

Path Parameters

id required

string

The classwork ID

referenceId required

string

The part reference ID

Request Body

PartialOmitClassworkPartInsertpartId

displayOrderoptional

integer

noteoptional

string

Example Request

application/json

{
  "note": "string",
  "displayOrder": 1
}

Response Schema

ClassworkPart

classworkIdrequired

string

pattern: ^[a-z0-9]{24}$

createdAtrequired

string

format: date-time

displayOrderrequired

number

idrequired

string

pattern: ^[a-z0-9]{24}$

noterequired

string

partIdrequirednullable

string

Null once the referenced part has been deleted: the row is kept (with `partName` as its memory of what it pointed at) so the teacher sees that a part went missing instead of the reference silently vanishing.

pattern: ^[a-z0-9]{24}$

partNamerequired

string

The part's name when it was referenced; the fallback label once the part is gone.

storeIdrequired

string

pattern: ^[a-z0-9]{24}$

updatedAtrequired

string

format: date-time

Example Response

200 OK — application/json

{
  "classworkId": "string",
  "partId": "string",
  "partName": "string",
  "note": "string",
  "displayOrder": 1,
  "id": "string",
  "storeId": "string",
  "createdAt": "2025-01-15T12:00:00.000Z",
  "updatedAt": "2025-01-15T12:00:00.000Z"
}