Messages

Update flags on multiple messages

Add and/or remove flags on multiple messages. Returns 200 when all UIDs succeed, 207 with per-UID outcome when some fail.

post/api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/flags

Request

  • Base URL: https://api.mail.hostinger.com
  • URL: https://api.mail.hostinger.com/api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/flags
  • Auth: HTTP bearer

Path parameters

mailboxResourceIdstring required

Resource ID of the managed mailbox the bearer token is authorized for.

folderstring required

Folder path (URL-encoded).

Request body

uidsinteger[] required

Message UIDs to update. 1-100 entries, each > 0.

addFlagsstring[]

IMAP flags to set on every listed message, e.g. \Seen, \Flagged, \Answered, $forwarded.

removeFlagsstring[]

IMAP flags to clear from every listed message.

Example request

{
  "uids": [
    42,
    43,
    44
  ],
  "addFlags": [
    "\\Seen",
    "\\Flagged",
    "$forwarded"
  ],
  "removeFlags": [
    "\\Seen"
  ]
}

Response

All UIDs updated successfully.

Example response

{
  "data": {
    "successful": [
      42,
      43
    ],
    "failed": [
      {
        "uid": 44,
        "reason": "Failed to update message flags"
      }
    ]
  }
}

Changes

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