Skip to main content
PUT
/
api
/
v1
/
mail
/
{id}
/
status
Set email status
curl --request PUT \
  --url http://localhost:3001/api/v1/mail/{id}/status \
  --header 'Content-Type: application/json' \
  --cookie nut-session= \
  --data '
{
  "status": "read"
}
'
{
  "success": true,
  "data": {
    "message": {
      "id": "<string>",
      "emailId": "<string>",
      "from": "Acme <hello@acme.com>",
      "to": [
        "<string>"
      ],
      "subject": "<string>",
      "folder": "inbox",
      "cc": [
        "<string>"
      ],
      "bcc": [
        "<string>"
      ],
      "messageId": "<string>",
      "attachments": [
        {
          "id": "<string>",
          "filename": "<string>",
          "contentType": "<string>",
          "contentDisposition": "<string>",
          "contentId": "<string>"
        }
      ],
      "receivedAt": "2023-11-07T05:31:56Z",
      "content": "<string>"
    }
  }
}

Authorizations

nut-session
string
cookie
required

Session cookie authentication

Path Parameters

id
string
required

Email ID

Body

application/json
status
enum<string>
required

Target status

Available options:
read,
unread

Response

Status updated

success
boolean
required
data
object