Notas
Cada operación de este grupo: lo que acepta, lo que devuelve y los errores con los que puede responder.
Operaciones
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 ruta
idstringObligatorioThe thread the notes are on, as
GET /threadsreturns it.
Devuelve
Every note on the thread, in display order.
Errores
Los errores que puede devolver cualquier operación400401403404422500Catálogo de errores
También disponible en
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 ruta
idstringObligatorioThe thread the notes are on, as
GET /threadsreturns it.
Cuerpo de la petición
contentstringObligatorioThe 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.Uno de"default""red""orange""yellow""green""blue""purple""pink"pinnedbooleanKeeps the note above the others. Defaults to false.
Devuelve
The note.
Errores
Los errores que puede devolver cualquier operación400401403404422500Catálogo de errores
También disponible en
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 ruta
idstringObligatorioThe thread the notes are on, as
GET /threadsreturns it.
Cuerpo de la petición
idsstring[]Obligatorio- De 1 a 200 elementos
Devuelve
The notes, in their new order.
Errores
Los errores que puede devolver cualquier operación400401403404422500Catálogo de errores
También disponible en
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 ruta
idstringObligatorioThe thread the notes are on, as
GET /threadsreturns it.noteIdstringObligatorioThe id of a note on that thread.
Cuerpo de la petición
contentstringThe new text, up to 20,000 characters.
De 1 a 20000 caracterescolorstringThe new colour.
Uno de"default""red""orange""yellow""green""blue""purple""pink"pinnedbooleanPins or unpins it.
Devuelve
The note as it is now.
Errores
Los errores que puede devolver cualquier operación400401403404422500Catálogo de errores
También disponible en
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 ruta
idstringObligatorioThe thread the notes are on, as
GET /threadsreturns it.noteIdstringObligatorioThe id of a note on that thread.
Devuelve
Deleted.
Errores
Los errores que puede devolver cualquier operación400401403404422500Catálogo de errores
También disponible en
Objetos
DeletedThreadNoteobject
objectstring- Uno de
"note" idstringthreadIdstringdeletedboolean- Uno de
true
ThreadNoteobject
objectstringObligatorio- Uno de
"note" idstringObligatoriothreadIdstringObligatoriocontentstringObligatorio- Hasta 20000 caracteres
colorstringObligatorio- Uno de
"default""red""orange""yellow""green""blue""purple""pink" pinnedbooleanObligatorioPinned notes are listed before the others.
orderintegerObligatorioWhere it sits among the notes that share its pinned state, lowest first.
createdAtstringObligatorio- Formato
date-time updatedAtstringObligatorio- Formato
date-time
ThreadNoteListobject
objectstring- Uno de
"list" dataThreadNote[]