Notas
Cada operação deste grupo: o que aceita, o que devolve e os erros com que pode responder.
Operações
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.
Parâmetros de caminho
idstringObrigatórioThe thread the notes are on, as
GET /threadsreturns it.
Devolve
Every note on the thread, in display order.
Erros
Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros
Também disponível em
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.
Parâmetros de caminho
idstringObrigatórioThe thread the notes are on, as
GET /threadsreturns it.
Corpo do pedido
contentstringObrigatórioThe text of the note, up to 20,000 characters. Leading and trailing spaces are trimmed.
De 1 a 20000 caracterescolorstringOne of the eight the app offers:
default,red,orange,yellow,green,blue,purpleorpink. Defaults todefault.Um de"default""red""orange""yellow""green""blue""purple""pink"pinnedbooleanKeeps the note above the others. Defaults to false.
Devolve
The note.
Erros
Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros
Também disponível em
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.
Parâmetros de caminho
idstringObrigatórioThe thread the notes are on, as
GET /threadsreturns it.
Corpo do pedido
idsstring[]Obrigatório- De 1 a 200 itens
Devolve
The notes, in their new order.
Erros
Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros
Também disponível em
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.
Parâmetros de caminho
idstringObrigatórioThe thread the notes are on, as
GET /threadsreturns it.noteIdstringObrigatórioThe id of a note on that thread.
Corpo do pedido
contentstringThe new text, up to 20,000 characters.
De 1 a 20000 caracterescolorstringThe new colour.
Um de"default""red""orange""yellow""green""blue""purple""pink"pinnedbooleanPins or unpins it.
Devolve
The note as it is now.
Erros
Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros
Também disponível em
DELETE/threads/{id}/notes/{noteId}
Delete a note
Gone for good. There is no bin for notes.
Requires the threads:write scope.
Parâmetros de caminho
idstringObrigatórioThe thread the notes are on, as
GET /threadsreturns it.noteIdstringObrigatórioThe id of a note on that thread.
Devolve
Deleted.
Erros
Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros
Também disponível em
Objetos
DeletedThreadNoteobject
objectstring- Um de
"note" idstringthreadIdstringdeletedboolean- Um de
true
ThreadNoteobject
objectstringObrigatório- Um de
"note" idstringObrigatóriothreadIdstringObrigatóriocontentstringObrigatório- Até 20000 caracteres
colorstringObrigatório- Um de
"default""red""orange""yellow""green""blue""purple""pink" pinnedbooleanObrigatórioPinned notes are listed before the others.
orderintegerObrigatórioWhere it sits among the notes that share its pinned state, lowest first.
createdAtstringObrigatório- Formato
date-time updatedAtstringObrigatório- Formato
date-time
ThreadNoteListobject
objectstring- Um de
"list" dataThreadNote[]