Skip to main content
Use PATCH /v1/blocks/:id to update an existing study block. Only include the fields you want to change — all other fields remain unchanged. This is also how you mark a block as complete.

Endpoint

Path Parameters

string
required
The unique identifier of the study block you want to update.

Body Parameters

All body parameters are optional. Include only the fields you want to change.
string
Reassign the block to a different subject by providing a new subject ID.
string
Updated start time in HH:MM format.
string
Updated end time in HH:MM format. Must be after start if both are provided.
boolean
Set to true to mark the block as complete, or false to mark it incomplete.
string
Updated topic or syllabus item label. Pass an empty string to clear the existing topic.

Response

Returns the full updated block object inside the data field.
string
Unique identifier for the study block.
string
The ID of the subject this block belongs to.
string
The display name of the subject.
string
The date of the block in YYYY-MM-DD format.
string
The block’s start time in HH:MM format.
string
The block’s end time in HH:MM format.
string
The topic label for this block, or null if none is set.
boolean
Whether the block has been marked as complete.
Example response

Marking a Block as Done

To mark a block as complete, send a PATCH request with only { "done": true } in the body. Every other field on the block stays exactly as it was.

Examples

You can update start and end independently. If you update only one, the API validates the final pair — so ensure the resulting start is still before end.