Notes
Every operation in this group: what it accepts, what it returns and the errors it can answer with.
Operations
Private notes pinned to a thread, the Notes panel of the reading pane.
Notes are private to a person. A key reads and writes the notes of the workspace owner, and an app those of the person who connected it. A key or an app limited to particular addresses reaches only the notes on threads that arrived at them.
GET/threads/{id}/notes
List the notes on a thread
Pinned notes first, then the rest in the order they were arranged. Notes are private to a person. A key reads and writes the notes of the workspace owner, and an app those of the person who connected it.
Requires the threads:read scope.
Path parameters
idstringRequiredThe thread the notes are on, as
GET /threadsreturns it.
Returns
Every note on the thread, in display order.
Errors
The errors every operation can return400401403404422500Error catalog
Also available in
POST/threads/{id}/notes
Add a note to a thread
A new note goes after the others. color is one of the eight the app offers, and pinned keeps it at the top. Notes are private to a person. A key reads and writes the notes of the workspace owner, and an app those of the person who connected it.
Requires the threads:write scope.
Path parameters
idstringRequiredThe thread the notes are on, as
GET /threadsreturns it.
Request body
contentstringRequiredThe text of the note, up to 20,000 characters. Leading and trailing spaces are trimmed.
1 to 20000 characterscolorstringOne of the eight the app offers:
default,red,orange,yellow,green,blue,purpleorpink. Defaults todefault.One of"default""red""orange""yellow""green""blue""purple""pink"pinnedbooleanKeeps the note above the others. Defaults to false.
Returns
The note.
Errors
The errors every operation can return400401403404422500Error catalog
Also available in
POST/threads/{id}/notes/reorder
Arrange the notes on a thread
Sets the order of every note on the thread at once, first to last. Pinned notes still come first. ids has to name each note exactly once, or the call is a 422 invalid_parameter on ids and nothing moves.
Requires the threads:write scope.
Path parameters
idstringRequiredThe thread the notes are on, as
GET /threadsreturns it.
Request body
idsstring[]Required- 1 to 200 items
Returns
The notes, in their new order.
Errors
The errors every operation can return400401403404422500Error catalog
Also available in
PATCH/threads/{id}/notes/{noteId}
Change a note
Changes its text, its colour or whether it is pinned. Give at least one. A note id that is not on this thread is a 404.
Requires the threads:write scope.
Path parameters
idstringRequiredThe thread the notes are on, as
GET /threadsreturns it.noteIdstringRequiredThe id of a note on that thread.
Request body
contentstringThe new text, up to 20,000 characters.
1 to 20000 characterscolorstringThe new colour.
One of"default""red""orange""yellow""green""blue""purple""pink"pinnedbooleanPins or unpins it.
Returns
The note as it is now.
Errors
The errors every operation can return400401403404422500Error catalog
Also available in
DELETE/threads/{id}/notes/{noteId}
Delete a note
Gone for good. There is no bin for notes.
Requires the threads:write scope.
Path parameters
idstringRequiredThe thread the notes are on, as
GET /threadsreturns it.noteIdstringRequiredThe id of a note on that thread.
Returns
Deleted.
Errors
The errors every operation can return400401403404422500Error catalog
Also available in
Objects
DeletedThreadNoteobject
objectstring- One of
"note" idstringthreadIdstringdeletedboolean- One of
true
ThreadNoteobject
objectstringRequired- One of
"note" idstringRequiredthreadIdstringRequiredcontentstringRequired- Up to 20000 characters
colorstringRequired- One of
"default""red""orange""yellow""green""blue""purple""pink" pinnedbooleanRequiredPinned notes are listed before the others.
orderintegerRequiredWhere it sits among the notes that share its pinned state, lowest first.
createdAtstringRequired- Format
date-time updatedAtstringRequired- Format
date-time
ThreadNoteListobject
objectstring- One of
"list" dataThreadNote[]