Update Thread
Mark a thread read or unread, move it, or add and remove labels.
PATCH
At least one of
read, folder, add_label_ids, or remove_label_ids is
required. A label ID cannot be both added and removed in the same request.
Moving a thread out of trash restores it and clears its deletion deadline.
The changes apply in this order: read, folder, added labels, removed labels.
They are not atomic, so a 404 for a label leaves the earlier changes applied.
A body with none of these keys returns a 422, even when it has other keys.
Path Parameters
Body Parameters
boolean
Marks every message in the thread read or unread.
string
Moves the thread to this folder. One of
inbox, archive, spam, or
trash. sent is assigned automatically and cannot be set.Folders
Every thread sits in exactly one folder within its inbox.
You can move a thread to
inbox, archive, spam, or trash. sent is
assigned automatically.
Response Fields
string
Always
inbox_thread.string
The ID of the thread.
string | null
The subject of the thread.
string
The folder the thread lives in after the update.
array
The labels attached to the thread, each with an
id, name, and color.boolean
True only when every message in the thread is read.