Remarques
Chaque opération de ce groupe : ce qu'elle accepte, ce qu'elle retourne et les erreurs qu'elle peut renvoyer.
Opérations
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.
Paramètres de chemin
idstringObligatoireThe thread the notes are on, as
GET /threadsreturns it.
Retourne
Every note on the thread, in display order.
Erreurs
Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs
Aussi disponible dans
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.
Paramètres de chemin
idstringObligatoireThe thread the notes are on, as
GET /threadsreturns it.
Corps de la requête
contentstringObligatoireThe text of the note, up to 20,000 characters. Leading and trailing spaces are trimmed.
De 1 à 20000 caractèrescolorstringOne of the eight the app offers:
default,red,orange,yellow,green,blue,purpleorpink. Defaults todefault.L'un de"default""red""orange""yellow""green""blue""purple""pink"pinnedbooleanKeeps the note above the others. Defaults to false.
Retourne
The note.
Erreurs
Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs
Aussi disponible dans
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.
Paramètres de chemin
idstringObligatoireThe thread the notes are on, as
GET /threadsreturns it.
Corps de la requête
idsstring[]Obligatoire- De 1 à 200 éléments
Retourne
The notes, in their new order.
Erreurs
Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs
Aussi disponible dans
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.
Paramètres de chemin
idstringObligatoireThe thread the notes are on, as
GET /threadsreturns it.noteIdstringObligatoireThe id of a note on that thread.
Corps de la requête
contentstringThe new text, up to 20,000 characters.
De 1 à 20000 caractèrescolorstringThe new colour.
L'un de"default""red""orange""yellow""green""blue""purple""pink"pinnedbooleanPins or unpins it.
Retourne
The note as it is now.
Erreurs
Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs
Aussi disponible dans
DELETE/threads/{id}/notes/{noteId}
Delete a note
Gone for good. There is no bin for notes.
Requires the threads:write scope.
Paramètres de chemin
idstringObligatoireThe thread the notes are on, as
GET /threadsreturns it.noteIdstringObligatoireThe id of a note on that thread.
Retourne
Deleted.
Erreurs
Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs
Aussi disponible dans
Objets
DeletedThreadNoteobject
objectstring- L'un de
"note" idstringthreadIdstringdeletedboolean- L'un de
true
ThreadNoteobject
objectstringObligatoire- L'un de
"note" idstringObligatoirethreadIdstringObligatoirecontentstringObligatoire- Jusqu'à 20000 caractères
colorstringObligatoire- L'un de
"default""red""orange""yellow""green""blue""purple""pink" pinnedbooleanObligatoirePinned notes are listed before the others.
orderintegerObligatoireWhere it sits among the notes that share its pinned state, lowest first.
createdAtstringObligatoire- Format
date-time updatedAtstringObligatoire- Format
date-time
ThreadNoteListobject
objectstring- L'un de
"list" dataThreadNote[]