Skip to main content
Use POST /v1/blocks to add a new study block to your schedule. Provide the subject, date, and time range — and optionally a topic. The API returns the created block.

Endpoint

Body Parameters

string
required
The ID of the subject this block should belong to. Must be a valid subject ID from your account.
string
required
The date for the block in YYYY-MM-DD format.
string
required
The start time for the block in HH:MM format.
string
required
The end time for the block in HH:MM format. Must be a time after start on the same date.
string
An optional topic or syllabus item label for this block.

Response

Returns the newly created block object inside the data field with HTTP status 201 Created.
string
Unique identifier for the newly created 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 was provided.
boolean
Whether the block has been marked as complete. Always false on creation.
Example response

Examples

A newly created block always has done set to false. Use the Update Block endpoint to mark it complete after your session.