SchoolSet APINotes

Update a user note

Updates a published or draft user note. The notes store also submits this request as POST with _method=patch when moving a note between folders.

Authentication

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

Path parameters

idintegerRequired

Query parameters

_methodenumOptional
Laravel method override used by the folder actions when the wire request is POST.
Allowed values:

Request

This endpoint expects an object.
titlestringRequired
notestringRequired

Note body; the editor sends serialized JSON content

favoritebooleanRequired
students_idlist of integersOptional
categories_idlist of integersOptional
attachments_idlist of integersOptional
folders_idlist of integersOptional
batch_idintegerOptional

Sent by the editor flow; not validated by UpdateUserNoteRequest

Response

Updated note envelope.
statusstring
messagestring
datamap from strings to any
UserNoteResource

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error