Messages

Set message read/unread status

Changed on

Change the read state of a message.

Pass readBoolean as true to mark the message as read, and false to mark it as unread. The default for any new message false (unread).

No PUT body is needed.

put/addresses/{email}/messages/{messageId}/read/{readBoolean}

Request

  • Base URL
    https://mailsac.com/api
  • Auth
    • API key in query parameter _mailsacKey
    • or API key in header Mailsac-Key

Response

Set read/unread status

_idstring string

Unique Mailsac-generated identifier for an email message

folderboolean

True to mark message as read, False to mark message unread. Default False

Example response

{
  "_id": "m3phnJ2ag3example-0"
}

Changes

    • info

      api operation id SetMessageReadStatus was added

    • info

      api tag Messages added

    • info

      api tag Email Messages API removed