Sticky note plugin
Use to read the notes of one board ("what is in my note for this course"). Returns each note's instance_id and Markdown text. To find a note without knowing its board use layouts.card.list.
semestra_session<token>Set by the sign-in endpoints for the web app. Requests other than GET, HEAD and OPTIONS also need the X-Semestra-CSRF header set to the semestra_csrf cookie.
scope_type*Scope TypeKind of board the note sits on; 'today' is the Program's Today page
"program""term""course""today"scope_id*Scope IdId of that Program, term or course
Successful Response
application/json- response
items*array<>curl -X GET 'https://example.com/sticky/notes?scope_type=program&scope_id=string'{ "items": [ { "instance_id": "string", "content": "string", "color": "string" } ]}Use when the user asks to jot something down in a note ("note the midterm scope in this course's sticky"): by default (mode append) the lines go after the note's text, so the same call made twice adds them twice. To rewrite or delete text, read the note first and send the whole new text with mode replace. At most 10 000 characters.
semestra_session<token>Set by the sign-in endpoints for the web app. Requests other than GET, HEAD and OPTIONS also need the X-Semestra-CSRF header set to the semestra_csrf cookie.
instance_id*Instance IdSticky note card instance id
application/json- body
content*ContentMarkdown text: the lines to add, or the whole new note with mode replace
length <= 10000mode?Modeappend adds the text on a new line after the note; replace overwrites it
"append""append""replace"Successful Response
application/json- response
instance_id*Instance Idcontent*Contentcolor?string|nullcurl -X PUT 'https://example.com/sticky/notes/string' \ -H 'Content-Type: application/json' \ -d '{ "content": "string"}'{ "instance_id": "string", "content": "string", "color": "string"}