Skip to main content
Resend Docs
current

Search documentation

Type to search this documentation.

On this pageOverview

Update Thread

Mark a thread read or unread, move it, or apply a label.

At least one of read, folder, or label_id is required.

The Inbox ID.

The Thread ID.

  • read (boolean) — Marks every message in the thread read or unread.

  • folder (string) — Moves the thread. One of inbox, archive, spam, or trash.

Applies this label to the thread.

Every thread sits in exactly one folder within its inbox.

Folder Meaning
inbox The default. The thread holds at least one received message.
archive The thread was archived.
spam The thread was marked as spam.
trash The thread is scheduled for deletion in 30 days.
sent Threads whose messages are all outbound.

You can move a thread to inbox, archive, spam, or trash. sent is assigned automatically.

  • object (string) — Always inbox_thread.

  • id (string) — The ID of the thread.

  • subject (string | null) — The subject of the thread.

  • folder (string) — The folder the thread lives in after the update.

  • labels (array) — The labels attached to the thread, each with an id, name, and color.

  • read (boolean) — True only when every message in the thread is read.

Node.js
import { Resend } from 'resend';

const resend = new Resend('re_xxxxxxxxx');

const { data, error } = await resend.inboxes.threads.update({
  inboxId: 'b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1',
  threadId: '4d8e2a1c-9b3f-4c6d-8a21-3e5f7c9c0d12',
  read: true,
  folder: 'spam',
});
cURL
curl -X PATCH 'https://api.resend.com/inboxes/b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1/threads/4d8e2a1c-9b3f-4c6d-8a21-3e5f7c9c0d12' \
     -H 'Authorization: Bearer re_xxxxxxxxx' \
     -H 'Content-Type: application/json' \
     -d $'{
  "read": true,
  "folder": "spam"
}'
Restore
curl -X PATCH 'https://api.resend.com/inboxes/b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1/threads/4d8e2a1c-9b3f-4c6d-8a21-3e5f7c9c0d12' \
     -H 'Authorization: Bearer re_xxxxxxxxx' \
     -H 'Content-Type: application/json' \
     -d $'{
  "folder": "inbox"
}'
Apply
curl -X PATCH 'https://api.resend.com/inboxes/b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1/threads/4d8e2a1c-9b3f-4c6d-8a21-3e5f7c9c0d12' \
     -H 'Authorization: Bearer re_xxxxxxxxx' \
     -H 'Content-Type: application/json' \
     -d $'{
  "label_id": "7f9c1d2e-4a6b-4c3d-8e15-9b0a7c6d5e34"
}'
CLI
resend inboxes threads update \
  --inbox_id b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1 \
  --thread_id 4d8e2a1c-9b3f-4c6d-8a21-3e5f7c9c0d12 \
  --read \
  --folder spam
Response
{
  "object": "inbox_thread",
  "id": "4d8e2a1c-9b3f-4c6d-8a21-3e5f7c9c0d12",
  "subject": "Refund for order 1041",
  "folder": "spam",
  "labels": [],
  "read": true
}
Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu