Inboxes

Update a thread

Mark every message read or unread (the same read state the mailbox and GET /v1/emails/receiving show), move the thread to inbox, archive, spam or trash (sent is assigned automatically), apply a label, or remove one with remove_label_id (not in Resend). At least one of read, folder, label_id or remove_label_id. Requires the inbound:read scope; moving to trash is a delete and needs the inbound:delete scope on a key created by a team owner or admin.

patch/v1/inboxes/{inbox_id}/threads/{thread_id}

Request

  • Base URL: https://smtpfa.st/api
  • URL: https://smtpfa.st/api/v1/inboxes/{inbox_id}/threads/{thread_id}
  • Auth: HTTP bearer

Path parameters

inbox_idstring required

The inbox id or its email address

thread_idstring required

The thread id

Request body

readboolean
folder'inbox' | 'archive' | 'spam' | 'trash'
label_idstring

Apply this label of the same inbox

remove_label_idstring

Remove this label. Not in Resend.

Response

The thread after the update

objectstring
idstring
subjectstring nullable
folder'inbox' | 'archive' | 'spam' | 'sent' | 'trash'
readboolean

True only when every message in the thread is read

received_atstring date-time

When the thread was last active. Not in Resend's thread object.

delete_afterstring date-time nullable

When a thread in trash is removed. Not in Resend.

Example response

{
  "object": "inbox_thread"
}

Changes

No recorded changes to this operation across all 1 revision of this API.