Mark a mailbox message read, archived or junk

PATCH

api

mailboxes

{id}

messages

{messageId}

TypeScript

import Inbound from "inboundemail";

const inbound = new Inbound();
const result = await inbound.messages.update("<mailboxId>", "<messageId>", {
  isRead: true
});

curl -X PATCH 'https://inbound.new/api/e2/mailboxes/<mailboxId>/messages/<messageId>' \
  -H "Authorization: Bearer $INBOUND_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "isRead": true
}'

import requests

url = "https://inbound.new/api/e2/mailboxes/{id}/messages/{messageId}"

payload = {
    "isRead": True,
    "isArchived": True,
    "isJunk": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({isRead: true, isArchived: true, isJunk: true})
};

fetch('https://inbound.new/api/e2/mailboxes/{id}/messages/{messageId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://inbound.new/api/e2/mailboxes/{id}/messages/{messageId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'isRead' => true,
    'isArchived' => true,
    'isJunk' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://inbound.new/api/e2/mailboxes/{id}/messages/{messageId}"

	payload := strings.NewReader("{\n  \"isRead\": true,\n  \"isArchived\": true,\n  \"isJunk\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://inbound.new/api/e2/mailboxes/{id}/messages/{messageId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"isRead\": true,\n  \"isArchived\": true,\n  \"isJunk\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://inbound.new/api/e2/mailboxes/{id}/messages/{messageId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"isRead\": true,\n  \"isArchived\": true,\n  \"isJunk\": true\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "folder": "inbox",
  "folderPath": "<string>",
  "threadId": "<string>",
  "subject": "<string>",
  "from": "<string>",
  "to": [
    "<string>"
  ],
  "date": "<string>",
  "preview": "<string>",
  "isRead": true,
  "isJunk": true,
  "hasAttachments": true
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Authorizations

Authorization

string

header

required

Your Inbound API key. Include it in the Authorization header as: Bearer

Path Parameters

string

required

messageId

string

required

Body

isRead

boolean

Sets or clears \Seen in the mailbox (shared with IMAP). The dashboard's read state is separate.

isArchived

boolean

Move to the Archive folder (true) or from Archive back to INBOX (false)

isJunk

boolean

Move to Junk (true) or back to the inbox (false). Sets this mailbox's own junk verdict, shared with IMAP; other mailboxes and the account-level spam verdict are unchanged.

Response

Response for status 200

string

required

folder

enum<string>

required

Available options:

inbox,

archive,

junk,

sent

folderPath

string · null · null

required

The exact mailbox folder path (for example Trash or Projects/2026), shared with IMAP and /mailboxes/{id}/folders; null when the message isn't in a folder of this mailbox

threadId

string · null · null

required

subject

string · null · null

required

from

string

required

string[]

required

date

string · null · null

required

preview

string · null · null

required

isRead

boolean

required

isJunk

boolean

required

hasAttachments

boolean

required

TypeScript

import Inbound from "inboundemail";

const inbound = new Inbound();
const result = await inbound.messages.update("<mailboxId>", "<messageId>", {
  isRead: true
});

curl -X PATCH 'https://inbound.new/api/e2/mailboxes/<mailboxId>/messages/<messageId>' \
  -H "Authorization: Bearer $INBOUND_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "isRead": true
}'

import requests

url = "https://inbound.new/api/e2/mailboxes/{id}/messages/{messageId}"

payload = {
    "isRead": True,
    "isArchived": True,
    "isJunk": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({isRead: true, isArchived: true, isJunk: true})
};

fetch('https://inbound.new/api/e2/mailboxes/{id}/messages/{messageId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://inbound.new/api/e2/mailboxes/{id}/messages/{messageId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'isRead' => true,
    'isArchived' => true,
    'isJunk' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://inbound.new/api/e2/mailboxes/{id}/messages/{messageId}"

	payload := strings.NewReader("{\n  \"isRead\": true,\n  \"isArchived\": true,\n  \"isJunk\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://inbound.new/api/e2/mailboxes/{id}/messages/{messageId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"isRead\": true,\n  \"isArchived\": true,\n  \"isJunk\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://inbound.new/api/e2/mailboxes/{id}/messages/{messageId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"isRead\": true,\n  \"isArchived\": true,\n  \"isJunk\": true\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "folder": "inbox",
  "folderPath": "<string>",
  "threadId": "<string>",
  "subject": "<string>",
  "from": "<string>",
  "to": [
    "<string>"
  ],
  "date": "<string>",
  "preview": "<string>",
  "isRead": true,
  "isJunk": true,
  "hasAttachments": true
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Overview

Domains

Endpoints

Email Addresses

Attachments

Authentication

Emails

Inbox

Mailboxes

Spam Filter

Guard

Webhooks

Mark a mailbox message read, archived or junk

Authorizations

Path Parameters

Body

Response