Skip to main content
import { createClient } from "@mailsai/sdk";

const client = createClient(); // reads MAILS_API_KEY

const result = await client.threads.update(
  "thrd_01JZX8K3M9Q4P7VN2YB6RTDC0E",
  {
    status: "closed",
    labels: ["resolved", "shipping"],
  },
);
console.log(result);
{
  "id": "thrd_01JZX8K3M9Q4P7VN2YB6RTDC0E",
  "agent_id": "agt_01JZX8K3M9Q4P7VN2YB6RTDC0E",
  "subject": "<subject>",
  "root_message_id": "msg_01JZX8K3M9Q4P7VN2YB6RTDC0E",
  "last_message_id": "msg_01JZX8K3M9Q4P7VN2YB6RTDC0E",
  "last_message_at": "2026-10-04T12:00:00.000Z",
  "message_count": 0,
  "participants": ["jordan@example.com"],
  "labels": ["<labels>"],
  "label_ids": ["lbl_01JZX8K3M9Q4P7VN2YB6RTDC0E"],
  "status": "open",
  "read": false,
  "folder": "inbox",
  "trashed_at": "2026-10-04T12:00:00.000Z",
  "assignee": {
    "id": "usr_01JZX8K3M9Q4P7VN2YB6RTDC0E",
    "email": "jordan@example.com",
    "name": "<name>"
  },
  "assigned_at": "2026-10-04T12:00:00.000Z",
  "notes_count": 0,
  "test_mode": false,
  "created_at": "2026-10-04T12:00:00.000Z",
  "updated_at": "2026-10-04T12:00:00.000Z",
  "previous": {
    "folder": "<folder>",
    "status": "<status>",
    "read": false,
    "labels": ["<labels>"],
    "assignee": {
      "id": "usr_01JZX8K3M9Q4P7VN2YB6RTDC0E",
      "email": "jordan@example.com",
      "name": "<name>"
    }
  }
}

Update a thread

Changes read, folder, status, labels, label_ids, add_labels, remove_labels and assignee; emits thread.updated when its read state, folder, status or labels changed.
PATCH/v1/threads/{id}scope · manage
import { createClient } from "@mailsai/sdk";

const client = createClient(); // reads MAILS_API_KEY

const result = await client.threads.update(
  "thrd_01JZX8K3M9Q4P7VN2YB6RTDC0E",
  {
    status: "closed",
    labels: ["resolved", "shipping"],
  },
);
console.log(result);
{
  "id": "thrd_01JZX8K3M9Q4P7VN2YB6RTDC0E",
  "agent_id": "agt_01JZX8K3M9Q4P7VN2YB6RTDC0E",
  "subject": "<subject>",
  "root_message_id": "msg_01JZX8K3M9Q4P7VN2YB6RTDC0E",
  "last_message_id": "msg_01JZX8K3M9Q4P7VN2YB6RTDC0E",
  "last_message_at": "2026-10-04T12:00:00.000Z",
  "message_count": 0,
  "participants": ["jordan@example.com"],
  "labels": ["<labels>"],
  "label_ids": ["lbl_01JZX8K3M9Q4P7VN2YB6RTDC0E"],
  "status": "open",
  "read": false,
  "folder": "inbox",
  "trashed_at": "2026-10-04T12:00:00.000Z",
  "assignee": {
    "id": "usr_01JZX8K3M9Q4P7VN2YB6RTDC0E",
    "email": "jordan@example.com",
    "name": "<name>"
  },
  "assigned_at": "2026-10-04T12:00:00.000Z",
  "notes_count": 0,
  "test_mode": false,
  "created_at": "2026-10-04T12:00:00.000Z",
  "updated_at": "2026-10-04T12:00:00.000Z",
  "previous": {
    "folder": "<folder>",
    "status": "<status>",
    "read": false,
    "labels": ["<labels>"],
    "assignee": {
      "id": "usr_01JZX8K3M9Q4P7VN2YB6RTDC0E",
      "email": "jordan@example.com",
      "name": "<name>"
    }
  }
}

Path Parameters

idstringrequired

Thread id.

Body Parameters

labelsstring[]

Label names, up to 50, each at most 64 characters. Replaces the thread's labels. Any such name works; a name that matches a label object picks up its id and colour.

label_idsstring[]

Label object ids (lbl_…). Replaces the thread's labels with those labels' names. Sent together with labels, the thread gets both.

statusstring

"archived" also files the thread in archive; "open" or "closed" on an archived thread moves it back to the inbox.

One of: open, closed, archived

readboolean

Mark the thread read (true) or unread (false).

folderstring

Move the thread to inbox, archive, spam, trash or sent. archive also sets status "archived", and moving an archived thread anywhere else reopens it. sent works only while every message in the thread is one you sent (422 otherwise). A thread in trash is deleted for good 30 days after it was moved there.

One of: inbox, archive, spam, trash, sent

assigneestring | null

Assign the thread to a member of the workspace, by email address (any case) or user id (usr_…); null unassigns it. me is the person signed in, in the dashboard or through an app connected by sign-in; a plain API key has no person behind it, so me from one is a 422. Someone who is not a member is refused with 422 assignee_not_member; GET /v1/members lists who can be assigned. Raises thread.assigned or thread.unassigned when the assignee changes.

add_labelsstring[]

Label names to put on the thread, keeping the ones it has (ignoring case, a name it already carries changes nothing). Applied after labels and label_ids when sent with them. A thread holds up to 50 labels (422 past that).

remove_labelsstring[]

Label names to take off the thread, ignoring case; a name it does not carry changes nothing. Applied after labels and label_ids when sent with them. A name may not be in both add_labels and remove_labels (422).

add_labels and remove_labels add and take off label names without replacing the rest, after labels or label_ids when those are sent too; a name in both is a 422. assignee gives the thread to a member of the workspace (an email, in any case, or a user id usr_…, as GET /v1/members lists them) or, as null, to nobody, and emits thread.assigned or thread.unassigned; assigning the member it already has changes nothing and emits nothing. Anyone else is a 422 assignee_not_member, a member of another workspace too. folder: "archive" and status: "archived" move together, and moving an archived thread anywhere else reopens it. folder: "sent" works only while every message in the thread is one the agent sent; a thread holding a received message is a 422. So is status: "archived" with any folder but archive. A test key cannot move a thread holding live mail to trash or assign it (403 live_mode_required).

Response

idstring

Thread id (thrd_…).

agent_idstring

Id (agt_…) of the agent the thread belongs to; a thread holds one agent's mail only.

subjectstring

The subject of the thread's first message, without one leading Re:, Fwd: or Fw:. Empty when that message had no subject.

root_message_idstring

Id of the message that started the thread: msg_… for one the agent sent, rcv_… for one it received.

last_message_idstring

Id of the message that joined the thread most recently (msg_… or rcv_…).

last_message_atstring

When the latest message joined the thread. The thread list is ordered by it, newest first.

message_countinteger

How many messages have joined the thread, sent and received.

participantsstring[]

Every address the thread has involved, in lower case and without repeats: the agent's own, the senders of received mail and the recipients of sent mail.

labelsstring[]

Label names, up to 50, each at most 64 characters. Any such name works; names that match a label object also appear in label_ids.

label_idsstring[]

Ids (lbl_…) of the label objects whose names are on this thread.

statusstring

open (every new thread), closed or archived, changed with PATCH. archived goes with folder archive, and only an open thread takes in new mail matched by its subject (mail from someone already in the thread).

One of: open, closed, archived

readboolean

False once new mail arrives; set it with PATCH.

folderstring

inbox, archive, spam, trash or sent. archive goes with status archived. sent holds a thread whose messages are all ones the agent sent, until a reply moves it to the inbox. Threads in trash are deleted for good 30 days after they were trashed.

One of: inbox, archive, spam, trash, sent

trashed_atstring

When the thread was moved to trash. Present only while it is there.

assigneeobject | null
assigned_atstring | null

When the thread was assigned to its assignee, or null while it is assigned to nobody.

notes_countinteger

How many notes the team has left on the thread (GET /v1/threads/{id}/notes).

test_modeboolean

True when the thread holds no live mail: every message in it was sent with a test key (mk_test_…) or delivered through POST /v1/test/inbound. A thread with any live message is live. Its thread.* events carry the same test_mode, and GET /v1/threads lists a key's own mode unless mode says otherwise.

created_atstring

When the thread was created, with its first message.

updated_atstring

When the thread last changed: a message joined it, or its read state, folder, status, labels or assignee changed.

previousobject

The fields this request changed, as they stood just before it, and only those: empty when nothing changed. Sending them back in another PATCH undoes the request, which is safer than a value read earlier, since the thread may have moved since.

Show propertiesHide properties
folderstring

The folder it was in, when this request moved it.

statusstring

Its status, when this request changed it.

readboolean

Whether it was read, when this request changed that.

labelsstring[]

Its label names, in their order, when this request changed them.

assigneeobject | null

Who it was assigned to, when this request changed that; null for nobody.

Was this page helpful?