Notes
Private notes pinned to a thread.
Notes tools
| Tool | What it does |
|---|---|
| listThreadNotes | The notes on one thread, pinned ones first, each with the id the other note tools take. |
| addThreadNote | Pin a note to a thread, in one of the eight colours the app offers. It goes after the others, and a pinned note stays on top. |
| updateThreadNote | Change the text of a note, its colour or whether it is pinned. |
| deleteThreadNote | Delete a note for good. There is no bin for notes. |
| reorderThreadNotes | Arrange the notes on a thread by naming every one of them, first to last. |
Notes are private to the person who wrote them, so these tools read and write the notes of the person who connected the client. Reading needs threads:read and changing needs threads:write, and a client limited to some addresses reaches only the threads that arrived at them.
In the app’s chat, adding, changing, deleting and arranging notes ask first unless you asked for them.
Reference
listThreadNotes
The private notes on one email thread, pinned ones first, each with the id the other note tools take. Notes belong to the person who wrote them, so this is that person's view.
Inputs
threadIdstringRequired- Not empty
Also available in
addThreadNote
Pin a private note to an email thread, as the Notes panel does. It goes after the other notes, and pinned keeps it at the top. color is one of the eight the app offers.
Inputs
threadIdstringRequired- Not empty
contentstringRequired- 1 to 20000 characters
colorstring- One of
"default""red""orange""yellow""green""blue""purple""pink" pinnedboolean
Also available in
updateThreadNote
Change a note on a thread: its text, its colour or whether it is pinned. Give at least one. Take the note id from listThreadNotes.
Inputs
threadIdstringRequired- Not empty
noteIdstringRequired- 1 to 64 characters
contentstring- 1 to 20000 characters
colorstring- One of
"default""red""orange""yellow""green""blue""purple""pink" pinnedboolean
Also available in
deleteThreadNote
Delete a note from a thread for good. There is no bin for notes. Take the note id from listThreadNotes.
Inputs
threadIdstringRequired- Not empty
noteIdstringRequired- 1 to 64 characters
Also available in
reorderThreadNotes
Arrange the notes on a thread, first to last. noteIds has to name every note on the thread exactly once; pinned notes still come first.
Inputs
threadIdstringRequired- Not empty
noteIdsstring[]Required- 1 to 200 items